35370 lines
1.2 MiB
35370 lines
1.2 MiB
{
|
|
"id": 0,
|
|
"name": "@supabase/auth-js",
|
|
"kind": 1,
|
|
"kindString": "Project",
|
|
"flags": {},
|
|
"originalName": "",
|
|
"children": [
|
|
{
|
|
"id": 1170,
|
|
"name": "AuthApiError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1171,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 33,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1172,
|
|
"name": "new AuthApiError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1173,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1174,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1175,
|
|
"name": "code",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1170,
|
|
"name": "AuthApiError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1162,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1161,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1177,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1178,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1166,
|
|
"name": "AuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1176,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 31,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1168,
|
|
"name": "AuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1171]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1177, 1176]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 30,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1160,
|
|
"name": "AuthError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1161,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 18,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1162,
|
|
"name": "new AuthError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1163,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1164,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1165,
|
|
"name": "code",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "Error.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1166,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1167,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1168,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 14,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1161]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1166, 1168]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 4,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Error",
|
|
"package": "typescript",
|
|
"name": "Error"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1170,
|
|
"name": "AuthApiError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1180,
|
|
"name": "AuthUnknownError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1227,
|
|
"name": "AuthImplicitGrantRedirectError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1228,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 90,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1229,
|
|
"name": "new AuthImplicitGrantRedirectError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1230,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1231,
|
|
"name": "details",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1232,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1234,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 90,
|
|
"character": 57
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1233,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 90,
|
|
"character": 42
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1234, 1233]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1227,
|
|
"name": "AuthImplicitGrantRedirectError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1192,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1191,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1251,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1252,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1199,
|
|
"name": "CustomAuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1235,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 89,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1236,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1238,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 89,
|
|
"character": 28
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1237,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 89,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1238, 1237]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 1249,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1197,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1250,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1198,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1239,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 95,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1240,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1241,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1245,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 100,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1246,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1248,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 89,
|
|
"character": 28
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1247,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 89,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1248, 1247]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1243,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 98,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1242,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 97,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1244,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 99,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1245, 1243, 1242, 1244]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1228]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1251, 1235, 1249, 1250]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [1239]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 88,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1218,
|
|
"name": "AuthInvalidCredentialsError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1219,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1220,
|
|
"name": "new AuthInvalidCredentialsError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1221,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1218,
|
|
"name": "AuthInvalidCredentialsError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1192,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1191,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1224,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1225,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1199,
|
|
"name": "CustomAuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1222,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1197,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1223,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1198,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1219]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1224, 1222, 1223]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 82,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1303,
|
|
"name": "AuthInvalidJwtError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1304,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 162,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1305,
|
|
"name": "new AuthInvalidJwtError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1306,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1303,
|
|
"name": "AuthInvalidJwtError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1192,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1191,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1309,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1310,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1199,
|
|
"name": "CustomAuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1307,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1197,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1308,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1198,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1304]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1309, 1307, 1308]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 161,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1210,
|
|
"name": "AuthInvalidTokenResponseError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1211,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1212,
|
|
"name": "new AuthInvalidTokenResponseError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1210,
|
|
"name": "AuthInvalidTokenResponseError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1192,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1191,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1215,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1216,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1199,
|
|
"name": "CustomAuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1213,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1197,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1214,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1198,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1211]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1215, 1213, 1214]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 76,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1254,
|
|
"name": "AuthPKCEGrantCodeExchangeError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1255,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 114,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1256,
|
|
"name": "new AuthPKCEGrantCodeExchangeError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1257,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1258,
|
|
"name": "details",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1259,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1261,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 114,
|
|
"character": 57
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1260,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 114,
|
|
"character": 42
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1261, 1260]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1254,
|
|
"name": "AuthPKCEGrantCodeExchangeError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1192,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1191,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1278,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1279,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1199,
|
|
"name": "CustomAuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1262,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 112,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1263,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1265,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 112,
|
|
"character": 28
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1264,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 112,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1265, 1264]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 1276,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1197,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1277,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1198,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1266,
|
|
"name": "toJSON",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 119,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1267,
|
|
"name": "toJSON",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1268,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1272,
|
|
"name": "details",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 124,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1273,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1275,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 112,
|
|
"character": 28
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1274,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 112,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1275, 1274]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1270,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 122,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1269,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 121,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1271,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 123,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1272, 1270, 1269, 1271]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1255]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1278, 1262, 1276, 1277]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [1266]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 111,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1281,
|
|
"name": "AuthRetryableFetchError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1282,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 130,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1283,
|
|
"name": "new AuthRetryableFetchError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1284,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1285,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1281,
|
|
"name": "AuthRetryableFetchError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1192,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1191,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1288,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1289,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1199,
|
|
"name": "CustomAuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1286,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1197,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1287,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1198,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1282]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1288, 1286, 1287]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 129,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1202,
|
|
"name": "AuthSessionMissingError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1203,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 67,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1204,
|
|
"name": "new AuthSessionMissingError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1202,
|
|
"name": "AuthSessionMissingError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1192,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1191,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1207,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1208,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1199,
|
|
"name": "CustomAuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1205,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1197,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1206,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1198,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1203]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1207, 1205, 1206]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 66,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1180,
|
|
"name": "AuthUnknownError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1181,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 48,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1182,
|
|
"name": "new AuthUnknownError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1183,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1184,
|
|
"name": "originalError",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1180,
|
|
"name": "AuthUnknownError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1162,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1161,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1186,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1187,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1166,
|
|
"name": "AuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1185,
|
|
"name": "originalError",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 46,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 1188,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 14,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1168,
|
|
"name": "AuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1181]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1186, 1185, 1188]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 45,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1291,
|
|
"name": "AuthWeakPasswordError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate."
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1292,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 150,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1293,
|
|
"name": "new AuthWeakPasswordError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1294,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1295,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1296,
|
|
"name": "reasons",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1291,
|
|
"name": "AuthWeakPasswordError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1192,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1191,
|
|
"name": "CustomAuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1300,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1301,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1199,
|
|
"name": "CustomAuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1298,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1197,
|
|
"name": "CustomAuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1297,
|
|
"name": "reasons",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Reasons why the password is deemed weak."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 148,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 548,
|
|
"name": "WeakPasswordReasons"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1299,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1198,
|
|
"name": "CustomAuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1292]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1300, 1298, 1297, 1299]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 144,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1190,
|
|
"name": "CustomAuthError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1191,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 59,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1192,
|
|
"name": "new CustomAuthError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1193,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1194,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1195,
|
|
"name": "status",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1196,
|
|
"name": "code",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1190,
|
|
"name": "CustomAuthError"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1162,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1161,
|
|
"name": "AuthError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1199,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link #status} will also be undefined."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 11,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1200,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"name": "ErrorCode"
|
|
}
|
|
]
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"id": 1166,
|
|
"name": "AuthError.code"
|
|
}
|
|
},
|
|
{
|
|
"id": 1197,
|
|
"name": "name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 56,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"name": "AuthError.name"
|
|
}
|
|
},
|
|
{
|
|
"id": 1198,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "HTTP status code that caused the error."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 57,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"id": 1168,
|
|
"name": "AuthError.status"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [1191]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1199, 1197, 1198]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 55,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1202,
|
|
"name": "AuthSessionMissingError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1210,
|
|
"name": "AuthInvalidTokenResponseError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1218,
|
|
"name": "AuthInvalidCredentialsError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1227,
|
|
"name": "AuthImplicitGrantRedirectError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1254,
|
|
"name": "AuthPKCEGrantCodeExchangeError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1281,
|
|
"name": "AuthRetryableFetchError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1291,
|
|
"name": "AuthWeakPasswordError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1303,
|
|
"name": "AuthInvalidJwtError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1,
|
|
"name": "GoTrueAdminApi",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 2,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 35,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 3,
|
|
"name": "new GoTrueAdminApi",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 4,
|
|
"name": "__namedParameters",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 5,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 11,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 44,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 12,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 13,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 14,
|
|
"name": "input",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInfo",
|
|
"package": "typescript",
|
|
"name": "RequestInfo"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "init",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInit",
|
|
"package": "typescript",
|
|
"name": "RequestInit"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Response",
|
|
"package": "typescript",
|
|
"name": "Response"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 7,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 41,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 8,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 9,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 10,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 6,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 40,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [11, 7, 6]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1,
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 16,
|
|
"name": "mfa",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains all MFA administration methods."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 27,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"dereferenced": {
|
|
"id": 1044,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication administration API.",
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1048,
|
|
"name": "deleteFactor",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1049,
|
|
"name": "deleteFactor",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.",
|
|
"tags": [
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#unenroll}\n"
|
|
},
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1050,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1028,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"dereferenced": {
|
|
"id": 1028,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1016,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1029,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1030,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the MFA factor to delete."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1018,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1031,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user whose factor is being deleted."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1021,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1030, 1031]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1016,
|
|
"character": 45
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1019,
|
|
"name": "AuthMFAAdminDeleteFactorResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1045,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1046,
|
|
"name": "listFactors",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Lists all factors associated to a user."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1047,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1041,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"dereferenced": {
|
|
"id": 1041,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1040,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1042,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1043,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1042,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1043]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1040,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1032,
|
|
"name": "AuthMFAAdminListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [1048, 1045]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1050,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 44,
|
|
"name": "createUser",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 152,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 45,
|
|
"name": "createUser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 46,
|
|
"name": "attributes",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"dereferenced": {
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 730,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.",
|
|
"text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 405,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "ban_duration",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Determines how long a user is banned for.",
|
|
"text": "The 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 431,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 356,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 731,
|
|
"name": "email_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's email address if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 412,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 736,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `id` for the user.",
|
|
"text": "Allows you to overwrite the default `id` set for the user.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 456,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
|
|
"text": "Call reauthenticate() to obtain the nonce first.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 373,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 737,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 366,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 735,
|
|
"name": "password_hash",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `password_hash` for the user's password.",
|
|
"text": "Allows 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 449,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 361,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 732,
|
|
"name": "phone_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's phone number if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 419,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 734,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `role` claim set in the user's access token JWT.",
|
|
"text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` 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 `service_role` is not recommended as it grants the user admin privileges.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 440,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 729,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 395,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [730, 733, 740, 731, 736, 738, 737, 735, 739, 732, 734, 729]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 384,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 722,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 68,
|
|
"name": "deleteUser",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 268,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 69,
|
|
"name": "deleteUser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Delete a user. Requires a `service_role` key."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 70,
|
|
"name": "id",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user id you want to remove."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 71,
|
|
"name": "shouldSoftDelete",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 `service_role` key in the browser.\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 41,
|
|
"name": "generateLink",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 118,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 42,
|
|
"name": "generateLink",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Generates email links and OTPs to be sent via a custom email provider."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 43,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 899,
|
|
"name": "GenerateLinkParams",
|
|
"dereferenced": {
|
|
"id": 899,
|
|
"name": "GenerateLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 752,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 874,
|
|
"name": "GenerateSignupLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 709,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 875,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 877,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 711,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 879,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 713,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 878,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 712,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 876,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 710,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "signup"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [877, 879, 878, 876]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 709,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 880,
|
|
"name": "GenerateInviteOrMagiclinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 716,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 881,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 883,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 719,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 884,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 720,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 882,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 717,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [883, 884, 882]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 716,
|
|
"character": 46
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 885,
|
|
"name": "GenerateRecoveryLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 723,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 886,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 888,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 726,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 889,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 727,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 887,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 724,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [888, 889, 887]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 723,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 890,
|
|
"name": "GenerateEmailChangeLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 730,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 891,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 893,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 733,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 894,
|
|
"name": "newEmail",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 895,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 738,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 892,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 731,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [893, 894, 895, 892]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 730,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 900,
|
|
"name": "GenerateLinkResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 61,
|
|
"name": "getUserById",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 62,
|
|
"name": "getUserById",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Get user by id."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 63,
|
|
"name": "uid",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 34,
|
|
"name": "inviteUserByEmail",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 85,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 35,
|
|
"name": "inviteUserByEmail",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Sends an invite link to an email address."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 36,
|
|
"name": "email",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The email address of the user."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 37,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Additional options to be included when inviting.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 38,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 39,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 89,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 40,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "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": "src/GoTrueAdminApi.ts",
|
|
"line": 92,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [39, 40]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 47,
|
|
"name": "listUsers",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 174,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 48,
|
|
"name": "listUsers",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Get a list of users.",
|
|
"text": "This function should only be called on a server. Never expose your `service_role` key in the browser."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 49,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1071,
|
|
"name": "PageParams",
|
|
"dereferenced": {
|
|
"id": 1071,
|
|
"name": "PageParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1109,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1072,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1073,
|
|
"name": "page",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The page number"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1111,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1074,
|
|
"name": "perPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Number of items returned per page"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1113,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1073, 1074]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1109,
|
|
"character": 25
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 50,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 51,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 177,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 52,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 54,
|
|
"name": "aud",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 177,
|
|
"character": 31
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 53,
|
|
"name": "users",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 177,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [54, 53]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1064,
|
|
"name": "Pagination"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 55,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 177,
|
|
"character": 59
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [51, 55]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 56,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 57,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 178,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 58,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 59,
|
|
"name": "users",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 178,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "tuple"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [59]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 60,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 178,
|
|
"character": 29
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [57, 60]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 27,
|
|
"name": "signOut",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 60,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 28,
|
|
"name": "signOut",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Removes a logged-in session."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 29,
|
|
"name": "jwt",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "A valid, logged-in JWT."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 30,
|
|
"name": "scope",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The logout sope.\n"
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "global"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "local"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "others"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "'global'"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 31,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 32,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 63,
|
|
"character": 15
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 33,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 63,
|
|
"character": 27
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [32, 33]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 64,
|
|
"name": "updateUserById",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 243,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 65,
|
|
"name": "updateUserById",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Updates the user data."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 66,
|
|
"name": "uid",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 67,
|
|
"name": "attributes",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"dereferenced": {
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 730,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.",
|
|
"text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 405,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "ban_duration",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Determines how long a user is banned for.",
|
|
"text": "The 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 431,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 356,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 731,
|
|
"name": "email_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's email address if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 412,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 736,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `id` for the user.",
|
|
"text": "Allows you to overwrite the default `id` set for the user.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 456,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
|
|
"text": "Call reauthenticate() to obtain the nonce first.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 373,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 737,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 366,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 735,
|
|
"name": "password_hash",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `password_hash` for the user's password.",
|
|
"text": "Allows 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 449,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 361,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 732,
|
|
"name": "phone_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's phone number if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 419,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 734,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `role` claim set in the user's access token JWT.",
|
|
"text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` 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 `service_role` is not recommended as it grants the user admin privileges.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 440,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 729,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 395,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [730, 733, 740, 731, 736, 738, 737, 735, 739, 732, 734, 729]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 384,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 722,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [2]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [16]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [44, 68, 41, 61, 34, 47, 27, 64]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 25,
|
|
"character": 21
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 78,
|
|
"name": "GoTrueClient",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 80,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 193,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 81,
|
|
"name": "new GoTrueClient",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Create a new client for use in the browser."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 82,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 527,
|
|
"name": "GoTrueClientOptions",
|
|
"dereferenced": {
|
|
"id": 527,
|
|
"name": "GoTrueClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 57,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 528,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 536,
|
|
"name": "autoRefreshToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 67,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 541,
|
|
"name": "debug",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 542,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 21
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 543,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 544,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 545,
|
|
"name": "args",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isRest": true
|
|
},
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 535,
|
|
"name": "detectSessionInUrl",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 65,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 539,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 540,
|
|
"name": "flowType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 802,
|
|
"name": "AuthFlowType",
|
|
"dereferenced": {
|
|
"id": 802,
|
|
"name": "AuthFlowType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 584,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "implicit"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "pkce"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 547,
|
|
"name": "hasCustomAuthorizationHeader",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Set to \"true\" if there is a custom authorization header set globally.",
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 530,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 61,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 531,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 61,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 532,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 533,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 546,
|
|
"name": "lock",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.",
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 518,
|
|
"name": "LockFunc",
|
|
"dereferenced": {
|
|
"id": 518,
|
|
"name": "LockFunc",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 519,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 23
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 520,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.",
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 526,
|
|
"name": "R",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 521,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Name of the lock to be acquired."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 522,
|
|
"name": "acquireTimeout",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 523,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operation to execute when the lock is acquired.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 524,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 69
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 525,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 526,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 526,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 537,
|
|
"name": "persistSession",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 538,
|
|
"name": "storage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1051,
|
|
"name": "SupportedStorage",
|
|
"dereferenced": {
|
|
"id": 1051,
|
|
"name": "SupportedStorage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1077,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Storage",
|
|
"package": "typescript",
|
|
"name": "Storage"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "getItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "setItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "removeItem"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
],
|
|
"name": "PromisifyMethods"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1052,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1053,
|
|
"name": "isServer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to `true` 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": "src/lib/types.ts",
|
|
"line": 1087,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1053]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1079,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 534,
|
|
"name": "storageKey",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 63,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 529,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
536, 541, 535, 539, 540, 547, 530, 546, 537, 538, 534, 529
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 57,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 78,
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 84,
|
|
"name": "admin",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 139,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1,
|
|
"name": "default",
|
|
"dereferenced": {
|
|
"id": 1,
|
|
"name": "GoTrueAdminApi",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 2,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 35,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 3,
|
|
"name": "new GoTrueAdminApi",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 4,
|
|
"name": "__namedParameters",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 5,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 11,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 44,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 12,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 13,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 14,
|
|
"name": "input",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInfo",
|
|
"package": "typescript",
|
|
"name": "RequestInfo"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "URL",
|
|
"package": "typescript",
|
|
"name": "URL"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "init",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "RequestInit",
|
|
"package": "typescript",
|
|
"name": "RequestInit"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Response",
|
|
"package": "typescript",
|
|
"name": "Response"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 7,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 41,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 8,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 9,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 10,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 6,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 40,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [11, 7, 6]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1,
|
|
"name": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 16,
|
|
"name": "mfa",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains all MFA administration methods."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 27,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1044,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"dereferenced": {
|
|
"id": 1044,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication administration API.",
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1048,
|
|
"name": "deleteFactor",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1049,
|
|
"name": "deleteFactor",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.",
|
|
"tags": [
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#unenroll}\n"
|
|
},
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1050,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1028,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"dereferenced": {
|
|
"id": 1028,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1016,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1029,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1030,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the MFA factor to delete."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1018,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1031,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user whose factor is being deleted."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1021,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1030, 1031]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1016,
|
|
"character": 45
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1019,
|
|
"name": "AuthMFAAdminDeleteFactorResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1045,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1046,
|
|
"name": "listFactors",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Lists all factors associated to a user."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1047,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1041,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"dereferenced": {
|
|
"id": 1041,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1040,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1042,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1043,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1042,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1043]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1040,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1032,
|
|
"name": "AuthMFAAdminListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [1048, 1045]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1050,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 44,
|
|
"name": "createUser",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 152,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 45,
|
|
"name": "createUser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 46,
|
|
"name": "attributes",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"dereferenced": {
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 730,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.",
|
|
"text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 405,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "ban_duration",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Determines how long a user is banned for.",
|
|
"text": "The 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 431,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 356,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 731,
|
|
"name": "email_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's email address if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 412,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 736,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `id` for the user.",
|
|
"text": "Allows you to overwrite the default `id` set for the user.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 456,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
|
|
"text": "Call reauthenticate() to obtain the nonce first.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 373,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 737,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 366,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 735,
|
|
"name": "password_hash",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `password_hash` for the user's password.",
|
|
"text": "Allows 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 449,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 361,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 732,
|
|
"name": "phone_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's phone number if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 419,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 734,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `role` claim set in the user's access token JWT.",
|
|
"text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` 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 `service_role` is not recommended as it grants the user admin privileges.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 440,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 729,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 395,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
730, 733, 740, 731, 736, 738, 737, 735, 739, 732, 734, 729
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 384,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 722,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 68,
|
|
"name": "deleteUser",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 268,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 69,
|
|
"name": "deleteUser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Delete a user. Requires a `service_role` key."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 70,
|
|
"name": "id",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user id you want to remove."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 71,
|
|
"name": "shouldSoftDelete",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 `service_role` key in the browser.\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 41,
|
|
"name": "generateLink",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 118,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 42,
|
|
"name": "generateLink",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Generates email links and OTPs to be sent via a custom email provider."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 43,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 899,
|
|
"name": "GenerateLinkParams",
|
|
"dereferenced": {
|
|
"id": 899,
|
|
"name": "GenerateLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 752,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 874,
|
|
"name": "GenerateSignupLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 709,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 875,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 877,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 711,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 879,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 713,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 878,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 712,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 876,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 710,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "signup"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [877, 879, 878, 876]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 709,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 880,
|
|
"name": "GenerateInviteOrMagiclinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 716,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 881,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 883,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 719,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 884,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 720,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 882,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 717,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [883, 884, 882]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 716,
|
|
"character": 46
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 885,
|
|
"name": "GenerateRecoveryLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 723,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 886,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 888,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 726,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 889,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 727,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 887,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 724,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [888, 889, 887]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 723,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 890,
|
|
"name": "GenerateEmailChangeLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 730,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 891,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 893,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 733,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 894,
|
|
"name": "newEmail",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 895,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 738,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 892,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 731,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [893, 894, 895, 892]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 730,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 900,
|
|
"name": "GenerateLinkResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 61,
|
|
"name": "getUserById",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 221,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 62,
|
|
"name": "getUserById",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Get user by id."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 63,
|
|
"name": "uid",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 34,
|
|
"name": "inviteUserByEmail",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 85,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 35,
|
|
"name": "inviteUserByEmail",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Sends an invite link to an email address."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 36,
|
|
"name": "email",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The email address of the user."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 37,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Additional options to be included when inviting.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 38,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 39,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 89,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 40,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "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": "src/GoTrueAdminApi.ts",
|
|
"line": 92,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [39, 40]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 47,
|
|
"name": "listUsers",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 174,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 48,
|
|
"name": "listUsers",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Get a list of users.",
|
|
"text": "This function should only be called on a server. Never expose your `service_role` key in the browser."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 49,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1071,
|
|
"name": "PageParams",
|
|
"dereferenced": {
|
|
"id": 1071,
|
|
"name": "PageParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1109,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1072,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1073,
|
|
"name": "page",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The page number"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1111,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1074,
|
|
"name": "perPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Number of items returned per page"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1113,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1073, 1074]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1109,
|
|
"character": 25
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 50,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 51,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 177,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 52,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 54,
|
|
"name": "aud",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 177,
|
|
"character": 31
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 53,
|
|
"name": "users",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 177,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [54, 53]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1064,
|
|
"name": "Pagination"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 55,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 177,
|
|
"character": 59
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [51, 55]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 56,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 57,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 178,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 58,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 59,
|
|
"name": "users",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 178,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "tuple"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [59]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 60,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 178,
|
|
"character": 29
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [57, 60]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 27,
|
|
"name": "signOut",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 60,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 28,
|
|
"name": "signOut",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Removes a logged-in session."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 29,
|
|
"name": "jwt",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "A valid, logged-in JWT."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 30,
|
|
"name": "scope",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The logout sope.\n"
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "global"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "local"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "others"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "'global'"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 31,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 32,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 63,
|
|
"character": 15
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 33,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 63,
|
|
"character": 27
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [32, 33]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 64,
|
|
"name": "updateUserById",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 243,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 65,
|
|
"name": "updateUserById",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Updates the user data."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 66,
|
|
"name": "uid",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 67,
|
|
"name": "attributes",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"dereferenced": {
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 730,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.",
|
|
"text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 405,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "ban_duration",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Determines how long a user is banned for.",
|
|
"text": "The 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 431,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 356,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 731,
|
|
"name": "email_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's email address if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 412,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 736,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `id` for the user.",
|
|
"text": "Allows you to overwrite the default `id` set for the user.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 456,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
|
|
"text": "Call reauthenticate() to obtain the nonce first.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 373,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 737,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 366,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 735,
|
|
"name": "password_hash",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `password_hash` for the user's password.",
|
|
"text": "Allows 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 449,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 361,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 732,
|
|
"name": "phone_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's phone number if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 419,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 734,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `role` claim set in the user's access token JWT.",
|
|
"text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` 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 `service_role` is not recommended as it grants the user admin privileges.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 440,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 729,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 395,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
730, 733, 740, 731, 736, 738, 737, 735, 739, 732, 734, 729
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 384,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 722,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [2]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [16]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [44, 68, 41, 61, 34, 47, 27, 64]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueAdminApi.ts",
|
|
"line": 25,
|
|
"character": 21
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 85,
|
|
"name": "mfa",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Namespace for the MFA methods."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 143,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 995,
|
|
"name": "GoTrueMFAApi",
|
|
"dereferenced": {
|
|
"id": 995,
|
|
"name": "GoTrueMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication API."
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1003,
|
|
"name": "challenge",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1004,
|
|
"name": "challenge",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1005,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 930,
|
|
"name": "MFAChallengeParams",
|
|
"dereferenced": {
|
|
"id": 930,
|
|
"name": "MFAChallengeParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 822,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 931,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 933,
|
|
"name": "channel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 826,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 932,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor to be challenged. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 824,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [933, 932]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 822,
|
|
"character": 33
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 961,
|
|
"name": "AuthMFAChallengeResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1012,
|
|
"name": "challengeAndVerify",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1013,
|
|
"name": "challengeAndVerify",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1014,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 934,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"dereferenced": {
|
|
"id": 934,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 829,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 935,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 937,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 833,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 936,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being verified. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 831,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [937, 936]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 829,
|
|
"character": 42
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 938,
|
|
"name": "AuthMFAVerifyResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 996,
|
|
"name": "enroll",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 997,
|
|
"name": "enroll",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` 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.",
|
|
"text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 998,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1078,
|
|
"name": "MFAEnrollTOTPParams",
|
|
"dereferenced": {
|
|
"id": 1078,
|
|
"name": "MFAEnrollTOTPParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1079,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1080,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1132,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 1082,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1136,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1081,
|
|
"name": "issuer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Domain which the user is enrolled with."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1134,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1080, 1082, 1081]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1088,
|
|
"name": "AuthMFAEnrollTOTPResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
},
|
|
{
|
|
"id": 999,
|
|
"name": "enroll",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1000,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1083,
|
|
"name": "MFAEnrollPhoneParams",
|
|
"dereferenced": {
|
|
"id": 1083,
|
|
"name": "MFAEnrollPhoneParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1084,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1085,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1140,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 1086,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1142,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1087,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Phone number associated with a factor. Number should conform to E.164 format"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1144,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1085, 1086, 1087]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1104,
|
|
"name": "AuthMFAEnrollPhoneResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
},
|
|
{
|
|
"id": 1001,
|
|
"name": "enroll",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1002,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 921,
|
|
"name": "MFAEnrollParams",
|
|
"dereferenced": {
|
|
"id": 921,
|
|
"name": "MFAEnrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 804,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 1078,
|
|
"name": "MFAEnrollTOTPParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1079,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1080,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1132,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 1082,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1136,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1081,
|
|
"name": "issuer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Domain which the user is enrolled with."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1134,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1080, 1082, 1081]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1083,
|
|
"name": "MFAEnrollPhoneParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1084,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1085,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1140,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 1086,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1142,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1087,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Phone number associated with a factor. Number should conform to E.164 format"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1144,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1085, 1086, 1087]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 951,
|
|
"name": "AuthMFAEnrollResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1017,
|
|
"name": "getAuthenticatorAssuranceLevel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1018,
|
|
"name": "getAuthenticatorAssuranceLevel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.",
|
|
"text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 984,
|
|
"name": "AuthMFAGetAuthenticatorAssuranceLevelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1015,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1016,
|
|
"name": "listFactors",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the list of MFA factors enabled for this user.",
|
|
"tags": [
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#enroll}"
|
|
},
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}"
|
|
},
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueClient#getUser}\n\n"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 972,
|
|
"name": "AuthMFAListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1009,
|
|
"name": "unenroll",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1010,
|
|
"name": "unenroll",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1011,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 922,
|
|
"name": "MFAUnenrollParams",
|
|
"dereferenced": {
|
|
"id": 922,
|
|
"name": "MFAUnenrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 806,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 923,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 924,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being unenrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 808,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [924]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 806,
|
|
"character": 32
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 952,
|
|
"name": "AuthMFAUnenrollResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1006,
|
|
"name": "verify",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1007,
|
|
"name": "verify",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1008,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 925,
|
|
"name": "MFAVerifyParams",
|
|
"dereferenced": {
|
|
"id": 925,
|
|
"name": "MFAVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 811,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 926,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 928,
|
|
"name": "challengeId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the challenge being verified. Returned in challenge()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 816,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 929,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 819,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 927,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being verified. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 813,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [928, 929, 927]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 811,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 938,
|
|
"name": "AuthMFAVerifyResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [1003, 1012, 996, 1017, 1015, 1009, 1006]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 935,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 148,
|
|
"name": "exchangeCodeForSession",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 596,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 149,
|
|
"name": "exchangeCodeForSession",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 150,
|
|
"name": "authCode",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 596,
|
|
"name": "AuthTokenResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 478,
|
|
"name": "getClaims",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2642,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 479,
|
|
"name": "getClaims",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "This method may change in future versions."
|
|
},
|
|
{
|
|
"tag": "description",
|
|
"text": "Gets the claims from a JWT. If the JWT is symmetric JWTs, it will call getUser() to verify against the server. If the JWT is asymmetric, it will be verified against the JWKS using the WebCrypto API.\n"
|
|
}
|
|
]
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 480,
|
|
"name": "jwt",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"name": "jwks",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 482,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 483,
|
|
"name": "keys",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2644,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 1135,
|
|
"name": "JWK"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [483]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 484,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 485,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2647,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 486,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 487,
|
|
"name": "claims",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2647,
|
|
"character": 16
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1131,
|
|
"name": "JwtPayload"
|
|
}
|
|
},
|
|
{
|
|
"id": 488,
|
|
"name": "header",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2647,
|
|
"character": 36
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1116,
|
|
"name": "JwtHeader"
|
|
}
|
|
},
|
|
{
|
|
"id": 489,
|
|
"name": "signature",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2647,
|
|
"character": 55
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"qualifiedName": "Uint8Array",
|
|
"package": "typescript",
|
|
"name": "Uint8Array"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [487, 488, 489]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 490,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2648,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [485, 490]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 491,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 492,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2650,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 493,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2650,
|
|
"character": 20
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [492, 493]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 494,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 495,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2651,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2651,
|
|
"character": 20
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [495, 496]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 187,
|
|
"name": "getSession",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 947,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 188,
|
|
"name": "getSession",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the session, refreshing it if necessary.",
|
|
"text": "The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\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 {@link #getUser()} instead.\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 189,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 190,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1040,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 191,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 192,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1041,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [192]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 193,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1043,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [190, 193]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 194,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 195,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1046,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 196,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 197,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1047,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [197]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 198,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1049,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [195, 198]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 199,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 200,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1052,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 201,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 202,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1053,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [202]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 203,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1055,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [200, 203]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 250,
|
|
"name": "getUser",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1178,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 251,
|
|
"name": "getUser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 252,
|
|
"name": "jwt",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used.\n"
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 359,
|
|
"name": "getUserIdentities",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1736,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 360,
|
|
"name": "getUserIdentities",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Gets all the identities linked to a user."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 361,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 362,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1738,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 363,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 364,
|
|
"name": "identities",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1739,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 670,
|
|
"name": "UserIdentity"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [364]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1741,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [362, 365]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 366,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 367,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1743,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 368,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1743,
|
|
"character": 20
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [367, 368]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 132,
|
|
"name": "initialize",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 298,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 133,
|
|
"name": "initialize",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1054,
|
|
"name": "InitializeResult"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 369,
|
|
"name": "linkIdentity",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1760,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 370,
|
|
"name": "linkIdentity",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 371,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 803,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"dereferenced": {
|
|
"id": 803,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 585,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 804,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 806,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 588,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 807,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 810,
|
|
"name": "queryParams",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "An object of query params"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 594,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 811,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 594,
|
|
"character": 18
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 812,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 813,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 808,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 590,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 809,
|
|
"name": "scopes",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A space-separated list of scopes granted to the OAuth application."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 592,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 814,
|
|
"name": "skipBrowserRedirect",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [810, 808, 809, 814]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 588,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 805,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 587,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 515,
|
|
"name": "Provider",
|
|
"dereferenced": {
|
|
"id": 515,
|
|
"name": "Provider",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 5,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "apple"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "azure"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "bitbucket"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "discord"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "facebook"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "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": "workos"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "zoom"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "fly"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [806, 805]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 585,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 624,
|
|
"name": "OAuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 331,
|
|
"name": "onAuthStateChange",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1634,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 332,
|
|
"name": "onAuthStateChange",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Receive a notification every time an auth event happens."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 333,
|
|
"name": "callback",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "A callback function to be invoked when an auth event happens.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 334,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 335,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 336,
|
|
"name": "event",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 517,
|
|
"name": "AuthChangeEvent"
|
|
}
|
|
},
|
|
{
|
|
"id": 337,
|
|
"name": "session",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 338,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 339,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1637,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 340,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 341,
|
|
"name": "subscription",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1637,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 741,
|
|
"name": "Subscription",
|
|
"dereferenced": {
|
|
"id": 741,
|
|
"name": "Subscription",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 742,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The subscriber UUID. This will be set by the client."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 463,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 743,
|
|
"name": "callback",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 467,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 744,
|
|
"name": "callback",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 745,
|
|
"name": "event",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 517,
|
|
"name": "AuthChangeEvent",
|
|
"dereferenced": {
|
|
"id": 517,
|
|
"name": "AuthChangeEvent",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 31,
|
|
"character": 12
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"id": 516,
|
|
"name": "AuthChangeEventMFA",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 29,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "MFA_CHALLENGE_VERIFIED"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 746,
|
|
"name": "session",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 747,
|
|
"name": "unsubscribe",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 471,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 748,
|
|
"name": "unsubscribe",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Call this to remove the listener."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [742]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [743, 747]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 459,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [341]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [339]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 180,
|
|
"name": "reauthenticate",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 863,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 181,
|
|
"name": "reauthenticate",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in."
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 554,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 280,
|
|
"name": "refreshSession",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1383,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 281,
|
|
"name": "refreshSession",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 282,
|
|
"name": "currentSession",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The current session. If passed in, it must contain a refresh token.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 283,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 284,
|
|
"name": "refresh_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1383,
|
|
"character": 42
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [284]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 554,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 184,
|
|
"name": "resend",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 898,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 185,
|
|
"name": "resend",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 186,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 847,
|
|
"name": "ResendParams",
|
|
"dereferenced": {
|
|
"id": 847,
|
|
"name": "ResendParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 665,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 848,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 850,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 668,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 851,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 669,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 852,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 854,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 673,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 853,
|
|
"name": "emailRedirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they have signed-in."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 671,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [854, 853]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 669,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 849,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 667,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 846,
|
|
"name": "EmailOtpType"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Extract",
|
|
"package": "typescript",
|
|
"name": "Extract"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [850, 851, 849]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 666,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 855,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 858,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 679,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 859,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 860,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 681,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [860]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 679,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 857,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 678,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 856,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 677,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 845,
|
|
"name": "MobileOtpType"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Extract",
|
|
"package": "typescript",
|
|
"name": "Extract"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [858, 857, 856]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 676,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 581,
|
|
"name": "AuthOtpResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 345,
|
|
"name": "resetPasswordForEmail",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1690,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 346,
|
|
"name": "resetPasswordForEmail",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Sends a password reset request to an email address. This method supports the PKCE flow."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 347,
|
|
"name": "email",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The email address of the user."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 348,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 349,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 351,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1694,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 350,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The URL to send the user to after they click the password reset link."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1693,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [351, 350]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 352,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 353,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1698,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 354,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 355,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1699,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [353, 355]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 356,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 357,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1701,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 358,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1701,
|
|
"character": 20
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [357, 358]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 268,
|
|
"name": "setSession",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1308,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 269,
|
|
"name": "setSession",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 270,
|
|
"name": "currentSession",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The current session that minimally contains an access token and refresh token.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 271,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 272,
|
|
"name": "access_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1309,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 273,
|
|
"name": "refresh_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1310,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [272, 273]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 554,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 136,
|
|
"name": "signInAnonymously",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 401,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 137,
|
|
"name": "signInAnonymously",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Creates a new anonymous user.",
|
|
"returns": "A session where the is_anonymous claim in the access token JWT set to true\n"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 138,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 749,
|
|
"name": "SignInAnonymouslyCredentials",
|
|
"dereferenced": {
|
|
"id": 749,
|
|
"name": "SignInAnonymouslyCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 474,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 750,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 751,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 475,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 752,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 754,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 483,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 753,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 481,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [754, 753]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 475,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [751]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 474,
|
|
"character": 43
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 554,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 168,
|
|
"name": "signInWithIdToken",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 656,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 169,
|
|
"name": "signInWithIdToken",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 170,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 815,
|
|
"name": "SignInWithIdTokenCredentials",
|
|
"dereferenced": {
|
|
"id": 815,
|
|
"name": "SignInWithIdTokenCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 600,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 816,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 820,
|
|
"name": "access_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 606,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 821,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 608,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 822,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 609,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 823,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 824,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 611,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [824]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 609,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 817,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `kakao`, `keycloak` (deprecated)."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 2
|
|
}
|
|
],
|
|
"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": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 818,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 76
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 819,
|
|
"name": "token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 604,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [820, 821, 822, 817, 819]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 600,
|
|
"character": 43
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 596,
|
|
"name": "AuthTokenResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 145,
|
|
"name": "signInWithOAuth",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 584,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 146,
|
|
"name": "signInWithOAuth",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 147,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 803,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"dereferenced": {
|
|
"id": 803,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 585,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 804,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 806,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 588,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 807,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 810,
|
|
"name": "queryParams",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "An object of query params"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 594,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 811,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 594,
|
|
"character": 18
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 812,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 813,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 808,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 590,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 809,
|
|
"name": "scopes",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A space-separated list of scopes granted to the OAuth application."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 592,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 814,
|
|
"name": "skipBrowserRedirect",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [810, 808, 809, 814]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 588,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 805,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 587,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 515,
|
|
"name": "Provider",
|
|
"dereferenced": {
|
|
"id": 515,
|
|
"name": "Provider",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 5,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "apple"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "azure"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "bitbucket"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "discord"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "facebook"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "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": "workos"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "zoom"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "fly"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [806, 805]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 585,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 624,
|
|
"name": "OAuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 171,
|
|
"name": "signInWithOtp",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 711,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 172,
|
|
"name": "signInWithOtp",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Log in a user using magiclink or a one-time password (OTP).",
|
|
"text": "If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\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.\n"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 173,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 785,
|
|
"name": "SignInWithPasswordlessCredentials",
|
|
"dereferenced": {
|
|
"id": 785,
|
|
"name": "SignInWithPasswordlessCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 546,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 786,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 787,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 549,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 788,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 550,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 789,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 793,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 562,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 792,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 560,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 790,
|
|
"name": "emailRedirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The redirect url embedded in the email link"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 552,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 791,
|
|
"name": "shouldCreateUser",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to false, this method will not create a new user. Defaults to true."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 554,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [793, 792, 790, 791]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 550,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [787, 788]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 547,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 794,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 796,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 568,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 797,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 800,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 578,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 801,
|
|
"name": "channel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Messaging channel to use (e.g. whatsapp or sms)"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 580,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 799,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 576,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 798,
|
|
"name": "shouldCreateUser",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to false, this method will not create a new user. Defaults to true."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 570,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [800, 801, 799, 798]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 568,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 795,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 567,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [796, 795]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 565,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 581,
|
|
"name": "AuthOtpResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 142,
|
|
"name": "signInWithPassword",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 521,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 143,
|
|
"name": "signInWithPassword",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Log in an existing user with an email and password or phone and password.",
|
|
"text": "Be 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.\n"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 144,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 772,
|
|
"name": "SignInWithPasswordCredentials",
|
|
"dereferenced": {
|
|
"id": 772,
|
|
"name": "SignInWithPasswordCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 524,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 773,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 774,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 527,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 776,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 530,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 777,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 778,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 532,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [778]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 530,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 775,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 529,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [774, 776, 775]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 525,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 779,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 782,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 540,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 783,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 784,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 542,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [784]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 540,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 781,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 539,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 780,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 537,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [782, 781, 780]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 535,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 609,
|
|
"name": "AuthTokenResponsePassword"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 177,
|
|
"name": "signInWithSSO",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 825,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 178,
|
|
"name": "signInWithSSO",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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.",
|
|
"text": "You 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.\n"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 179,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 861,
|
|
"name": "SignInWithSSO",
|
|
"dereferenced": {
|
|
"id": 861,
|
|
"name": "SignInWithSSO",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 685,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 862,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 864,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 690,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 865,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 867,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 694,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 866,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they have signed-in."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 692,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [867, 866]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 690,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 863,
|
|
"name": "providerId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "UUID of the SSO provider to invoke single-sign on to."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 688,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [864, 863]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 686,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 868,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 869,
|
|
"name": "domain",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Domain name of the organization for which to invoke single-sign on."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 699,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 870,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 701,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 871,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 873,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 705,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 872,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they have signed-in."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 703,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [873, 872]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 701,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [869, 870]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 697,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 637,
|
|
"name": "SSOResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 321,
|
|
"name": "signOut",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1590,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 322,
|
|
"name": "signOut",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.",
|
|
"text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using `others` scope, no `SIGNED_OUT` event is fired!\n"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 323,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1075,
|
|
"name": "SignOut",
|
|
"dereferenced": {
|
|
"id": 1075,
|
|
"name": "SignOut",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1116,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1076,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1077,
|
|
"name": "scope",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "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": "src/lib/types.ts",
|
|
"line": 1127,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "global"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "local"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "others"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1077]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1116,
|
|
"character": 22
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 324,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 325,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1590,
|
|
"character": 67
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [325]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 139,
|
|
"name": "signUp",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 444,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 140,
|
|
"name": "signUp",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Creates a new user.",
|
|
"text": "Be 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.\n",
|
|
"returns": "A logged-in session if the server has \"autoconfirm\" ON"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 141,
|
|
"name": "credentials",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 755,
|
|
"name": "SignUpWithPasswordCredentials",
|
|
"dereferenced": {
|
|
"id": 755,
|
|
"name": "SignUpWithPasswordCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 487,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 756,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 757,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 490,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 759,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 493,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 760,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 763,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 503,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 762,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 501,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 761,
|
|
"name": "emailRedirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The redirect url embedded in the email link"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 495,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [763, 762, 761]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 493,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 758,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 492,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [757, 759, 758]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 488,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 764,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 767,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 511,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 768,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 770,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 519,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 771,
|
|
"name": "channel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Messaging channel to use (e.g. whatsapp or sms)"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 521,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 769,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 517,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [770, 771, 769]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 511,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 766,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 510,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 765,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 508,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [767, 766, 765]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 506,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 554,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 427,
|
|
"name": "startAutoRefresh",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2175,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 428,
|
|
"name": "startAutoRefresh",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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.",
|
|
"text": "If you set the {@link GoTrueClientOptions#autoRefreshToken} 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{@see #stopAutoRefresh}\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 429,
|
|
"name": "stopAutoRefresh",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 2188,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 430,
|
|
"name": "stopAutoRefresh",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Stops an active auto refresh process running in the background (if any).",
|
|
"text": "If you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee {@link #startAutoRefresh} for more details.\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 372,
|
|
"name": "unlinkIdentity",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1796,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 373,
|
|
"name": "unlinkIdentity",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 374,
|
|
"name": "identity",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 670,
|
|
"name": "UserIdentity",
|
|
"dereferenced": {
|
|
"id": 670,
|
|
"name": "UserIdentity",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 679,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 285,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 671,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 278,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 673,
|
|
"name": "identity_data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 280,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 674,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 675,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 676,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 677,
|
|
"name": "identity_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 283,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 680,
|
|
"name": "last_sign_in_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 286,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 678,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 284,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 681,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 287,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 672,
|
|
"name": "user_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 279,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [679, 671, 673, 677, 680, 678, 681, 672]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 277,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 375,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 376,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1798,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 377,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1799,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [376, 378]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 379,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 380,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1801,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 381,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1801,
|
|
"character": 20
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [380, 381]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 256,
|
|
"name": "updateUser",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1239,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 257,
|
|
"name": "updateUser",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Updates user data for a logged in user."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 258,
|
|
"name": "attributes",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 722,
|
|
"name": "UserAttributes",
|
|
"dereferenced": {
|
|
"id": 722,
|
|
"name": "UserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 727,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 381,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 723,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 356,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 726,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
|
|
"text": "Call reauthenticate() to obtain the nonce first.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 373,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 725,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 366,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 724,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 361,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [727, 723, 726, 725, 724]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 352,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 259,
|
|
"name": "options",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 260,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 261,
|
|
"name": "emailRedirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 1242,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [261]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 646,
|
|
"name": "UserResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 174,
|
|
"name": "verifyOtp",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 764,
|
|
"character": 8
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 175,
|
|
"name": "verifyOtp",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Log in a user given a User supplied OTP or TokenHash received through mobile or email."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 176,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 825,
|
|
"name": "VerifyOtpParams",
|
|
"dereferenced": {
|
|
"id": 825,
|
|
"name": "VerifyOtpParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 615,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 826,
|
|
"name": "VerifyMobileOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 830,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 623,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 831,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 833,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site.",
|
|
"tags": [
|
|
{
|
|
"tag": "deprecated",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 632,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 832,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 625,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [833, 832]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 827,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 618,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 828,
|
|
"name": "token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The otp sent to the user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 620,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 829,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 622,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 845,
|
|
"name": "MobileOtpType",
|
|
"dereferenced": {
|
|
"id": 845,
|
|
"name": "MobileOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 662,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [830, 827, 828, 829]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 616,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 834,
|
|
"name": "VerifyEmailOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 835,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 637,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 838,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 839,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 841,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site.",
|
|
"tags": [
|
|
{
|
|
"tag": "deprecated",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 650,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 840,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 644,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [841, 840]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 836,
|
|
"name": "token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The otp sent to the user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 639,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 837,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 641,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [835, 838, 836, 837]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 635,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 842,
|
|
"name": "VerifyTokenHashParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 843,
|
|
"name": "token_hash",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The token hash used in an email link"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 844,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 659,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [843, 844]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 654,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 554,
|
|
"name": "AuthResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [80]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [84, 85]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [
|
|
148, 478, 187, 250, 359, 132, 369, 331, 180, 280, 184, 345, 268, 136, 168, 145, 171,
|
|
142, 177, 321, 139, 427, 429, 372, 256, 174
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/GoTrueClient.ts",
|
|
"line": 130,
|
|
"character": 21
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 507,
|
|
"name": "NavigatorLockAcquireTimeoutError",
|
|
"kind": 128,
|
|
"kindString": "Class",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 508,
|
|
"name": "constructor",
|
|
"kind": 512,
|
|
"kindString": "Constructor",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 509,
|
|
"name": "new NavigatorLockAcquireTimeoutError",
|
|
"kind": 16384,
|
|
"kindString": "Constructor signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 510,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 507,
|
|
"name": "NavigatorLockAcquireTimeoutError"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "LockAcquireTimeoutError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "LockAcquireTimeoutError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 511,
|
|
"name": "isAcquireTimeout",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isReadonly": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/locks.ts",
|
|
"line": 24,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": true
|
|
},
|
|
"defaultValue": "true",
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "LockAcquireTimeoutError.isAcquireTimeout"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"kind": 512,
|
|
"children": [508]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [511]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/locks.ts",
|
|
"line": 31,
|
|
"character": 13
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"name": "LockAcquireTimeoutError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 666,
|
|
"name": "AMREntry",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "An authentication methord reference (AMR) entry.",
|
|
"text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n",
|
|
"tags": [
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 667,
|
|
"name": "method",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Authentication method name."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 268,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "password"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 668,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "otp"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "oauth"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "mfa/totp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 669,
|
|
"name": "timestamp",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 274,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [667, 669]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 266,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 728,
|
|
"name": "AdminUserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 730,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.",
|
|
"text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 405,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "ban_duration",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Determines how long a user is banned for.",
|
|
"text": "The 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 431,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 356,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.email"
|
|
}
|
|
},
|
|
{
|
|
"id": 731,
|
|
"name": "email_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's email address if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 412,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 736,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `id` for the user.",
|
|
"text": "Allows you to overwrite the default `id` set for the user.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 456,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
|
|
"text": "Call reauthenticate() to obtain the nonce first.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 373,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.nonce"
|
|
}
|
|
},
|
|
{
|
|
"id": 737,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 366,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.password"
|
|
}
|
|
},
|
|
{
|
|
"id": 735,
|
|
"name": "password_hash",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `password_hash` for the user's password.",
|
|
"text": "Allows 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.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 449,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 361,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"name": "Omit.phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 732,
|
|
"name": "phone_confirm",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Confirms the user's phone number if set to true.",
|
|
"text": "Only a service role can modify.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 419,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 734,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The `role` claim set in the user's access token JWT.",
|
|
"text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` 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 `service_role` is not recommended as it grants the user admin privileges.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 440,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 729,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 395,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [730, 733, 740, 731, 736, 738, 737, 735, 739, 732, 734, 729]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 384,
|
|
"character": 17
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 722,
|
|
"name": "UserAttributes"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
}
|
|
],
|
|
"qualifiedName": "Omit",
|
|
"package": "typescript",
|
|
"name": "Omit"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 682,
|
|
"name": "Factor",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "A MFA factor.",
|
|
"tags": [
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#enroll}"
|
|
},
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#listFactors}"
|
|
},
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAAdminApi#listFactors}\n"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 688,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 312,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 685,
|
|
"name": "factor_type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Type of factor. `totp` and `phone` supported with this version"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 307,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 686,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "totp"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 684,
|
|
"name": "friendly_name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Friendly name of the factor, useful to disambiguate between multiple factors."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 302,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 683,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 299,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 687,
|
|
"name": "status",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Factor's status."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 310,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "verified"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "unverified"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 689,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 313,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [688, 685, 684, 683, 687, 689]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 297,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 897,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 747,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 898,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The URL which will be appended to the email link generated."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 749,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [897, 898]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 741,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1044,
|
|
"name": "GoTrueAdminMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication administration API.",
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1048,
|
|
"name": "deleteFactor",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1049,
|
|
"name": "deleteFactor",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.",
|
|
"tags": [
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#unenroll}\n"
|
|
},
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1050,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1028,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"dereferenced": {
|
|
"id": 1028,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1016,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1029,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1030,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the MFA factor to delete."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1018,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1031,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user whose factor is being deleted."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1021,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1030, 1031]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1016,
|
|
"character": 45
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1019,
|
|
"name": "AuthMFAAdminDeleteFactorResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1045,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1046,
|
|
"name": "listFactors",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Lists all factors associated to a user."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1047,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1041,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"dereferenced": {
|
|
"id": 1041,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1040,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1042,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1043,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1042,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1043]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1040,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1032,
|
|
"name": "AuthMFAAdminListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [1048, 1045]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1050,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 995,
|
|
"name": "GoTrueMFAApi",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains the full multi-factor authentication API."
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1003,
|
|
"name": "challenge",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1004,
|
|
"name": "challenge",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1005,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 930,
|
|
"name": "MFAChallengeParams",
|
|
"dereferenced": {
|
|
"id": 930,
|
|
"name": "MFAChallengeParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 822,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 931,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 933,
|
|
"name": "channel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 826,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 932,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor to be challenged. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 824,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [933, 932]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 822,
|
|
"character": 33
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 961,
|
|
"name": "AuthMFAChallengeResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1012,
|
|
"name": "challengeAndVerify",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1013,
|
|
"name": "challengeAndVerify",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1014,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 934,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"dereferenced": {
|
|
"id": 934,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 829,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 935,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 937,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 833,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 936,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being verified. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 831,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [937, 936]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 829,
|
|
"character": 42
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 938,
|
|
"name": "AuthMFAVerifyResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 996,
|
|
"name": "enroll",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 997,
|
|
"name": "enroll",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` 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.",
|
|
"text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 998,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1078,
|
|
"name": "MFAEnrollTOTPParams",
|
|
"dereferenced": {
|
|
"id": 1078,
|
|
"name": "MFAEnrollTOTPParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1079,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1080,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1132,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 1082,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1136,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1081,
|
|
"name": "issuer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Domain which the user is enrolled with."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1134,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1080, 1082, 1081]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1088,
|
|
"name": "AuthMFAEnrollTOTPResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
},
|
|
{
|
|
"id": 999,
|
|
"name": "enroll",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1000,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1083,
|
|
"name": "MFAEnrollPhoneParams",
|
|
"dereferenced": {
|
|
"id": 1083,
|
|
"name": "MFAEnrollPhoneParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1084,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1085,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1140,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 1086,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1142,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1087,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Phone number associated with a factor. Number should conform to E.164 format"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1144,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1085, 1086, 1087]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1104,
|
|
"name": "AuthMFAEnrollPhoneResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
},
|
|
{
|
|
"id": 1001,
|
|
"name": "enroll",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1002,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 921,
|
|
"name": "MFAEnrollParams",
|
|
"dereferenced": {
|
|
"id": 921,
|
|
"name": "MFAEnrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 804,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 1078,
|
|
"name": "MFAEnrollTOTPParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1079,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1080,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1132,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 1082,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1136,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1081,
|
|
"name": "issuer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Domain which the user is enrolled with."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1134,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1080, 1082, 1081]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1083,
|
|
"name": "MFAEnrollPhoneParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1084,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1085,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1140,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 1086,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1142,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1087,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Phone number associated with a factor. Number should conform to E.164 format"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1144,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1085, 1086, 1087]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 951,
|
|
"name": "AuthMFAEnrollResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1017,
|
|
"name": "getAuthenticatorAssuranceLevel",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1018,
|
|
"name": "getAuthenticatorAssuranceLevel",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.",
|
|
"text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n"
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 984,
|
|
"name": "AuthMFAGetAuthenticatorAssuranceLevelResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1015,
|
|
"name": "listFactors",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1016,
|
|
"name": "listFactors",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Returns the list of MFA factors enabled for this user.",
|
|
"tags": [
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#enroll}"
|
|
},
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}"
|
|
},
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueClient#getUser}\n\n"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 972,
|
|
"name": "AuthMFAListFactorsResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1009,
|
|
"name": "unenroll",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1010,
|
|
"name": "unenroll",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1011,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 922,
|
|
"name": "MFAUnenrollParams",
|
|
"dereferenced": {
|
|
"id": 922,
|
|
"name": "MFAUnenrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 806,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 923,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 924,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being unenrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 808,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [924]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 806,
|
|
"character": 32
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 952,
|
|
"name": "AuthMFAUnenrollResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1006,
|
|
"name": "verify",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 1007,
|
|
"name": "verify",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app."
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 1008,
|
|
"name": "params",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 925,
|
|
"name": "MFAVerifyParams",
|
|
"dereferenced": {
|
|
"id": 925,
|
|
"name": "MFAVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 811,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 926,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 928,
|
|
"name": "challengeId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the challenge being verified. Returned in challenge()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 816,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 929,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 819,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 927,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being verified. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 813,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [928, 929, 927]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 811,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 938,
|
|
"name": "AuthMFAVerifyResponse"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [1003, 1012, 996, 1017, 1015, 1009, 1006]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 935,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1135,
|
|
"name": "JWK",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1138,
|
|
"name": "alg",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1228,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1137,
|
|
"name": "key_ops",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1227,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1139,
|
|
"name": "kid",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1229,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1136,
|
|
"name": "kty",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1226,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "RSA"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "EC"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "oct"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1138, 1137, 1139, 1136]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1225,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 1140,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1141,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 657,
|
|
"name": "Session",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 660,
|
|
"name": "access_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 241,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 663,
|
|
"name": "expires_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A timestamp of when the token will expire. Returned when a login is confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 253,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 662,
|
|
"name": "expires_in",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 249,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 659,
|
|
"name": "provider_refresh_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "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": "src/lib/types.ts",
|
|
"line": 237,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 658,
|
|
"name": "provider_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 232,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 661,
|
|
"name": "refresh_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "A one-time used refresh token that never expires."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 245,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 664,
|
|
"name": "token_type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 254,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 665,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 255,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User",
|
|
"dereferenced": {
|
|
"id": 697,
|
|
"name": "User",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 708,
|
|
"name": "action_link",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 336,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 699,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 327,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 690,
|
|
"name": "UserAppMetadata",
|
|
"dereferenced": {
|
|
"id": 690,
|
|
"name": "UserAppMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 691,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 317,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [691]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 316,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 692,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 693,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 701,
|
|
"name": "aud",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 329,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 702,
|
|
"name": "confirmation_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 330,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 712,
|
|
"name": "confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 340,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 711,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 339,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 709,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 337,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 704,
|
|
"name": "email_change_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 332,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 713,
|
|
"name": "email_confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 341,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 721,
|
|
"name": "factors",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 349,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 682,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 698,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 326,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 718,
|
|
"name": "identities",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 346,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 670,
|
|
"name": "UserIdentity"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 707,
|
|
"name": "invited_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 335,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 719,
|
|
"name": "is_anonymous",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 347,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 720,
|
|
"name": "is_sso_user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 348,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 715,
|
|
"name": "last_sign_in_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 343,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 705,
|
|
"name": "new_email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 333,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 706,
|
|
"name": "new_phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 334,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 710,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 338,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 714,
|
|
"name": "phone_confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 342,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 703,
|
|
"name": "recovery_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 331,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 716,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 344,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 717,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 345,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 700,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 328,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 694,
|
|
"name": "UserMetadata",
|
|
"dereferenced": {
|
|
"id": 694,
|
|
"name": "UserMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 321,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 695,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 696,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
708, 699, 701, 702, 712, 711, 709, 704, 713, 721, 698, 718, 707, 719, 720, 715,
|
|
705, 706, 710, 714, 703, 716, 717, 700
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 325,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [660, 663, 662, 659, 658, 661, 664, 665]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 228,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 741,
|
|
"name": "Subscription",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 742,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The subscriber UUID. This will be set by the client."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 463,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 743,
|
|
"name": "callback",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 467,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 744,
|
|
"name": "callback",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"id": 745,
|
|
"name": "event",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 517,
|
|
"name": "AuthChangeEvent",
|
|
"dereferenced": {
|
|
"id": 517,
|
|
"name": "AuthChangeEvent",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 31,
|
|
"character": 12
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"id": 516,
|
|
"name": "AuthChangeEventMFA",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 29,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "MFA_CHALLENGE_VERIFIED"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 746,
|
|
"name": "session",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 747,
|
|
"name": "unsubscribe",
|
|
"kind": 2048,
|
|
"kindString": "Method",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 471,
|
|
"character": 2
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 748,
|
|
"name": "unsubscribe",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Call this to remove the listener."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [742]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"kind": 2048,
|
|
"children": [743, 747]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 459,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 697,
|
|
"name": "User",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 708,
|
|
"name": "action_link",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 336,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 699,
|
|
"name": "app_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 327,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 690,
|
|
"name": "UserAppMetadata",
|
|
"dereferenced": {
|
|
"id": 690,
|
|
"name": "UserAppMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 691,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 317,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [691]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 316,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 692,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 693,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 701,
|
|
"name": "aud",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 329,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 702,
|
|
"name": "confirmation_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 330,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 712,
|
|
"name": "confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 340,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 711,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 339,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 709,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 337,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 704,
|
|
"name": "email_change_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 332,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 713,
|
|
"name": "email_confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 341,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 721,
|
|
"name": "factors",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 349,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 682,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 698,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 326,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 718,
|
|
"name": "identities",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 346,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 670,
|
|
"name": "UserIdentity"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 707,
|
|
"name": "invited_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 335,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 719,
|
|
"name": "is_anonymous",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 347,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 720,
|
|
"name": "is_sso_user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 348,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 715,
|
|
"name": "last_sign_in_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 343,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 705,
|
|
"name": "new_email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 333,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 706,
|
|
"name": "new_phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 334,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 710,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 338,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 714,
|
|
"name": "phone_confirmed_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 342,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 703,
|
|
"name": "recovery_sent_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 331,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 716,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 344,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 717,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 345,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 700,
|
|
"name": "user_metadata",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 328,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 694,
|
|
"name": "UserMetadata",
|
|
"dereferenced": {
|
|
"id": 694,
|
|
"name": "UserMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 321,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 695,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 696,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [
|
|
708, 699, 701, 702, 712, 711, 709, 704, 713, 721, 698, 718, 707, 719, 720, 715, 705,
|
|
706, 710, 714, 703, 716, 717, 700
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 325,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 690,
|
|
"name": "UserAppMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 691,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 317,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [691]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 316,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 692,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 693,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 722,
|
|
"name": "UserAttributes",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 727,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 381,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 723,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's email."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 356,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 726,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
|
|
"text": "Call reauthenticate() to obtain the nonce first.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 373,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 725,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 366,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 724,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The user's phone."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 361,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [727, 723, 726, 725, 724]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 352,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 670,
|
|
"name": "UserIdentity",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 679,
|
|
"name": "created_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 285,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 671,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 278,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 673,
|
|
"name": "identity_data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 280,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 674,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"indexSignature": {
|
|
"id": 675,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 676,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 677,
|
|
"name": "identity_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 283,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 680,
|
|
"name": "last_sign_in_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 286,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 678,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 284,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 681,
|
|
"name": "updated_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 287,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 672,
|
|
"name": "user_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 279,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [679, 671, 673, 677, 680, 678, 681, 672]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 277,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 694,
|
|
"name": "UserMetadata",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 321,
|
|
"character": 17
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 695,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 696,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 834,
|
|
"name": "VerifyEmailOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 835,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 637,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 838,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 839,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 841,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site.",
|
|
"tags": [
|
|
{
|
|
"tag": "deprecated",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 650,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 840,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 644,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [841, 840]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 836,
|
|
"name": "token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The otp sent to the user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 639,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 837,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 641,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [835, 838, 836, 837]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 635,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 826,
|
|
"name": "VerifyMobileOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 830,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 623,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 831,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 833,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site.",
|
|
"tags": [
|
|
{
|
|
"tag": "deprecated",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 632,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 832,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 625,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [833, 832]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 827,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 618,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 828,
|
|
"name": "token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The otp sent to the user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 620,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 829,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 622,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 845,
|
|
"name": "MobileOtpType",
|
|
"dereferenced": {
|
|
"id": 845,
|
|
"name": "MobileOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 662,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [830, 827, 828, 829]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 616,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 842,
|
|
"name": "VerifyTokenHashParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 843,
|
|
"name": "token_hash",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The token hash used in an email link"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 844,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 659,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [843, 844]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 654,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 517,
|
|
"name": "AuthChangeEvent",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 31,
|
|
"character": 12
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"id": 516,
|
|
"name": "AuthChangeEventMFA",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 29,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "MFA_CHALLENGE_VERIFIED"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 516,
|
|
"name": "AuthChangeEventMFA",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 29,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "MFA_CHALLENGE_VERIFIED"
|
|
}
|
|
},
|
|
{
|
|
"id": 802,
|
|
"name": "AuthFlowType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 584,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "implicit"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "pkce"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1028,
|
|
"name": "AuthMFAAdminDeleteFactorParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1016,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1029,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1030,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the MFA factor to delete."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1018,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1031,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user whose factor is being deleted."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1021,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1030, 1031]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1016,
|
|
"character": 45
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1019,
|
|
"name": "AuthMFAAdminDeleteFactorResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1003,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1020,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1021,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1005,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1022,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1023,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor that was successfully deleted."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1007,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1023]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1005,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1024,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1009,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1021, 1024]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1004,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1025,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1026,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1011,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1027,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1011,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1026, 1027]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1011,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1041,
|
|
"name": "AuthMFAAdminListFactorsParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1040,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1042,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1043,
|
|
"name": "userId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1042,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1043]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1040,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1032,
|
|
"name": "AuthMFAAdminListFactorsResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "expermental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1027,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1033,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1034,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1029,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1035,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1036,
|
|
"name": "factors",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "All factors attached to the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1031,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 682,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1036]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1029,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1037,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1033,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1034, 1037]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1028,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1038,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1039,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1035,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1040,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1035,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1039, 1040]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1035,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 961,
|
|
"name": "AuthMFAChallengeResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 873,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 962,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 963,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 875,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 964,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 967,
|
|
"name": "expires_at",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 883,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 965,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the newly created challenge."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 877,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 966,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Factor Type which generated the challenge"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 880,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "totp"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [967, 965, 966]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 875,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 968,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 885,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [963, 968]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 874,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 969,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 970,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 887,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 971,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 887,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [970, 971]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 887,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1104,
|
|
"name": "AuthMFAEnrollPhoneResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1182,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1105,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1106,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1184,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1107,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1110,
|
|
"name": "friendly_name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Friendly name of the factor, useful for distinguishing between factors"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1192,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1108,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor that was just enrolled (in an unverified state)."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1186,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1111,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Phone number of the MFA factor in E.164 format. Used to send messages"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1195,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1109,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Type of MFA factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1189,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1110, 1108, 1111, 1109]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1184,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1112,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1197,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1106, 1112]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1183,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1113,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1114,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1200,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1115,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1201,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1114, 1115]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1199,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 951,
|
|
"name": "AuthMFAEnrollResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 861,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 1088,
|
|
"name": "AuthMFAEnrollTOTPResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1147,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1089,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1090,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1149,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1091,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1099,
|
|
"name": "friendly_name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Friendly name of the factor, useful for distinguishing between factors"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1173,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1092,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor that was just enrolled (in an unverified state)."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1151,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1094,
|
|
"name": "totp",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "TOTP enrollment information."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1157,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1095,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1096,
|
|
"name": "qr_code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1161,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1097,
|
|
"name": "secret",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1166,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1098,
|
|
"name": "uri",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1170,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1096, 1097, 1098]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1157,
|
|
"character": 14
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1093,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Type of MFA factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1154,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1099, 1092, 1094, 1093]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1149,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1100,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1175,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1090, 1100]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1148,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1101,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1102,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1178,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1103,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1179,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1102, 1103]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1177,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1104,
|
|
"name": "AuthMFAEnrollPhoneResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1182,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1105,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1106,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1184,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1107,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1110,
|
|
"name": "friendly_name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Friendly name of the factor, useful for distinguishing between factors"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1192,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1108,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor that was just enrolled (in an unverified state)."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1186,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1111,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Phone number of the MFA factor in E.164 format. Used to send messages"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1195,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1109,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Type of MFA factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1189,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1110, 1108, 1111, 1109]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1184,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1112,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1197,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1106, 1112]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1183,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1113,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1114,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1200,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1115,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1201,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1114, 1115]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1199,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1088,
|
|
"name": "AuthMFAEnrollTOTPResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1147,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1089,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1090,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1149,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1091,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1099,
|
|
"name": "friendly_name",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Friendly name of the factor, useful for distinguishing between factors"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1173,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1092,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor that was just enrolled (in an unverified state)."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1151,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1094,
|
|
"name": "totp",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "TOTP enrollment information."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1157,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1095,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1096,
|
|
"name": "qr_code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1161,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1097,
|
|
"name": "secret",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1166,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1098,
|
|
"name": "uri",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1170,
|
|
"character": 10
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1096, 1097, 1098]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1157,
|
|
"character": 14
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1093,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Type of MFA factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1154,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1099, 1092, 1094, 1093]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1149,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1100,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1175,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1090, 1100]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1148,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1101,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1102,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1178,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1103,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1179,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1102, 1103]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1177,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 984,
|
|
"name": "AuthMFAGetAuthenticatorAssuranceLevelResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 906,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 985,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 986,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 908,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 987,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 990,
|
|
"name": "currentAuthenticationMethods",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 925,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 666,
|
|
"name": "AMREntry"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 988,
|
|
"name": "currentLevel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Current AAL level of the session."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 910,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 983,
|
|
"name": "AuthenticatorAssuranceLevels"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 989,
|
|
"name": "nextLevel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.",
|
|
"tags": [
|
|
{
|
|
"tag": "see",
|
|
"text": "{@link GoTrueMFAApi#challenge}\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 918,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 983,
|
|
"name": "AuthenticatorAssuranceLevels"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [990, 988, 989]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 908,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 991,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 927,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [986, 991]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 907,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 992,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 993,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 929,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 994,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 929,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [993, 994]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 929,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 972,
|
|
"name": "AuthMFAListFactorsResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 889,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 973,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 974,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 891,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 975,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 976,
|
|
"name": "all",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "All available factors (verified and unverified)."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 893,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 682,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 978,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Only verified Phone factors. (A subset of `all`.)"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 898,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 682,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 977,
|
|
"name": "totp",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Only verified TOTP factors. (A subset of `all`.)"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 896,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 682,
|
|
"name": "Factor"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [976, 978, 977]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 891,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 979,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 900,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [974, 979]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 890,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 980,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 981,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 902,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 982,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 902,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [981, 982]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 902,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 952,
|
|
"name": "AuthMFAUnenrollResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 863,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 953,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 954,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 865,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 955,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 956,
|
|
"name": "id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor that was successfully unenrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 867,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [956]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 865,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 957,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 869,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [954, 957]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 864,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 958,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 959,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 871,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 960,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 871,
|
|
"character": 18
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [959, 960]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 871,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 938,
|
|
"name": "AuthMFAVerifyResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 836,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 939,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 940,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 838,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 941,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 942,
|
|
"name": "access_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "New access token (JWT) after successful verification."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 840,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 944,
|
|
"name": "expires_in",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Number of seconds in which the access token will expire."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 846,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 945,
|
|
"name": "refresh_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Refresh token you can use to obtain new access tokens when expired."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 849,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 943,
|
|
"name": "token_type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Type of token, typically `Bearer`."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 843,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 946,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Updated user profile."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 852,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [942, 944, 945, 943, 946]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 838,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 947,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 854,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [940, 947]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 837,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 948,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 949,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 857,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 950,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 858,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [949, 950]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 856,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 581,
|
|
"name": "AuthOtpResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "AuthOtpResponse is returned when OTP is used.",
|
|
"text": "{@see AuthResponse}\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 135,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 582,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 583,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 137,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 584,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 587,
|
|
"name": "messageId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 137,
|
|
"character": 41
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 586,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 137,
|
|
"character": 26
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 585,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 137,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [587, 586, 585]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 137,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 588,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 138,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [583, 588]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 136,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 589,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 590,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 141,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 591,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 594,
|
|
"name": "messageId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 141,
|
|
"character": 41
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 593,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 141,
|
|
"character": 26
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 592,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 141,
|
|
"character": 14
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [594, 593, 592]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 141,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 595,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 142,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [590, 595]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 140,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 554,
|
|
"name": "AuthResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 97,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 555,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 556,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 99,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 557,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 559,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 101,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 558,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 100,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [559, 558]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 99,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 560,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 103,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [556, 560]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 98,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 561,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 562,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 106,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 563,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 565,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 108,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 564,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 107,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [565, 564]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 106,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 566,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 110,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [562, 566]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 105,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 567,
|
|
"name": "AuthResponsePassword",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 113,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 568,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 569,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 115,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 570,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 572,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 117,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 571,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 116,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 573,
|
|
"name": "weak_password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 118,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 550,
|
|
"name": "WeakPassword"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [572, 571, 573]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 115,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 574,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 120,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [569, 574]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 114,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 575,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 576,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 123,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 577,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 579,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 125,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 578,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 124,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [579, 578]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 123,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 580,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 127,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [576, 580]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 122,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 596,
|
|
"name": "AuthTokenResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 145,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 597,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 598,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 147,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 599,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 601,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 149,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
}
|
|
},
|
|
{
|
|
"id": 600,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 148,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [601, 600]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 147,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 602,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 151,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [598, 602]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 146,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 603,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 604,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 154,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 605,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 607,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 156,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 606,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 155,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [607, 606]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 154,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 608,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 158,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [604, 608]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 153,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 609,
|
|
"name": "AuthTokenResponsePassword",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 161,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 610,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 611,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 163,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 612,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 614,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 165,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
}
|
|
},
|
|
{
|
|
"id": 613,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 164,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
}
|
|
},
|
|
{
|
|
"id": 615,
|
|
"name": "weakPassword",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 166,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 550,
|
|
"name": "WeakPassword"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [614, 613, 615]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 163,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 616,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 168,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [611, 616]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 162,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 617,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 618,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 171,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 619,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 621,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 173,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 620,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 172,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"name": "weakPassword",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 174,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [621, 620, 622]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 171,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 623,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 176,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [618, 623]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 170,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 983,
|
|
"name": "AuthenticatorAssuranceLevels",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 904,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "aal1"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "aal2"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1057,
|
|
"name": "CallRefreshTokenResult",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1092,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1058,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1060,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1095,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1059,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1094,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 657,
|
|
"name": "Session"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1060, 1059]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1093,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1061,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1063,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1099,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
},
|
|
{
|
|
"id": 1062,
|
|
"name": "session",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1098,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1063, 1062]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1097,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 890,
|
|
"name": "GenerateEmailChangeLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 730,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 891,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 893,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 733,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 894,
|
|
"name": "newEmail",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 895,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 738,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 892,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 731,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [893, 894, 895, 892]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 730,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 880,
|
|
"name": "GenerateInviteOrMagiclinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 716,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 881,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 883,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 719,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 884,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 720,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 882,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 717,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [883, 884, 882]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 716,
|
|
"character": 46
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 899,
|
|
"name": "GenerateLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 752,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 874,
|
|
"name": "GenerateSignupLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 709,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 875,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 877,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 711,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 879,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 713,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 878,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 712,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 876,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 710,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "signup"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [877, 879, 878, 876]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 709,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 880,
|
|
"name": "GenerateInviteOrMagiclinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 716,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 881,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 883,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 719,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 884,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 720,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 882,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 717,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [883, 884, 882]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 716,
|
|
"character": 46
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 885,
|
|
"name": "GenerateRecoveryLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 723,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 886,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 888,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 726,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 889,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 727,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 887,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 724,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [888, 889, 887]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 723,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 890,
|
|
"name": "GenerateEmailChangeLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 730,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 891,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 893,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 733,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 894,
|
|
"name": "newEmail",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 737,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 895,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 738,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 892,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 731,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [893, 894, 895, 892]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 730,
|
|
"character": 44
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 913,
|
|
"name": "GenerateLinkProperties",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The properties related to the email link generated"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 775,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 914,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 915,
|
|
"name": "action_link",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 780,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 916,
|
|
"name": "email_otp",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 785,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 917,
|
|
"name": "hashed_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The hashed token appended to the action link."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 789,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 918,
|
|
"name": "redirect_to",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The URL appended to the action link."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 791,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 919,
|
|
"name": "verification_type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The verification type that the email link is associated to."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 793,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 920,
|
|
"name": "GenerateLinkType",
|
|
"dereferenced": {
|
|
"id": 920,
|
|
"name": "GenerateLinkType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 796,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [915, 916, 917, 918, 919]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 775,
|
|
"character": 37
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 900,
|
|
"name": "GenerateLinkResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 758,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 901,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 902,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 760,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 903,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 904,
|
|
"name": "properties",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 761,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 913,
|
|
"name": "GenerateLinkProperties"
|
|
}
|
|
},
|
|
{
|
|
"id": 905,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 762,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [904, 905]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 760,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 906,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 764,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [902, 906]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 759,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 907,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 908,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 767,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 909,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 910,
|
|
"name": "properties",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 768,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 911,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 769,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [910, 911]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 767,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 912,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 771,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [908, 912]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 766,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 920,
|
|
"name": "GenerateLinkType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 796,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_current"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change_new"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 885,
|
|
"name": "GenerateRecoveryLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 723,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 886,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 888,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 726,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 889,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 727,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 887,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 724,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [888, 889, 887]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 723,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 874,
|
|
"name": "GenerateSignupLinkParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 709,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 875,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 877,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 711,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 879,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 713,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 896,
|
|
"name": "GenerateLinkOptions"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "data"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "redirectTo"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
},
|
|
{
|
|
"id": 878,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 712,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 876,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 710,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "signup"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [877, 879, 878, 876]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 709,
|
|
"character": 39
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 527,
|
|
"name": "GoTrueClientOptions",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 57,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 528,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 536,
|
|
"name": "autoRefreshToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 67,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 541,
|
|
"name": "debug",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 542,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 21
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 543,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 544,
|
|
"name": "message",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 545,
|
|
"name": "args",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {
|
|
"isRest": true
|
|
},
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 535,
|
|
"name": "detectSessionInUrl",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 65,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 539,
|
|
"name": "fetch",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 73,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"name": "Fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 540,
|
|
"name": "flowType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 75,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 802,
|
|
"name": "AuthFlowType",
|
|
"dereferenced": {
|
|
"id": 802,
|
|
"name": "AuthFlowType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 584,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "implicit"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "pkce"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 547,
|
|
"name": "hasCustomAuthorizationHeader",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Set to \"true\" if there is a custom authorization header set globally.",
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 88,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 530,
|
|
"name": "headers",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 61,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 531,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 61,
|
|
"character": 12
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 532,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 533,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 546,
|
|
"name": "lock",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.",
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 83,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 518,
|
|
"name": "LockFunc",
|
|
"dereferenced": {
|
|
"id": 518,
|
|
"name": "LockFunc",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 519,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 23
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 520,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.",
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 526,
|
|
"name": "R",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 521,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Name of the lock to be acquired."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 522,
|
|
"name": "acquireTimeout",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 523,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operation to execute when the lock is acquired.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 524,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 69
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 525,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 526,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 526,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 537,
|
|
"name": "persistSession",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 69,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 538,
|
|
"name": "storage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 71,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1051,
|
|
"name": "SupportedStorage",
|
|
"dereferenced": {
|
|
"id": 1051,
|
|
"name": "SupportedStorage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1077,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Storage",
|
|
"package": "typescript",
|
|
"name": "Storage"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "getItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "setItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "removeItem"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
],
|
|
"name": "PromisifyMethods"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1052,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1053,
|
|
"name": "isServer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to `true` 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": "src/lib/types.ts",
|
|
"line": 1087,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1053]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1079,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 534,
|
|
"name": "storageKey",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 63,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 529,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 59,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [536, 541, 535, 539, 540, 547, 530, 546, 537, 538, 534, 529]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 57,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1054,
|
|
"name": "InitializeResult",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1090,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1055,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1056,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1090,
|
|
"character": 33
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1056]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1090,
|
|
"character": 31
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1116,
|
|
"name": "JwtHeader",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1204,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1117,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1118,
|
|
"name": "alg",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1205,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "RS256"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "ES256"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "HS256"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1119,
|
|
"name": "kid",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1206,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1120,
|
|
"name": "typ",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1207,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1118, 1119, 1120]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1204,
|
|
"character": 24
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1131,
|
|
"name": "JwtPayload",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1221,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"id": 1121,
|
|
"name": "RequiredClaims"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1132,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1221,
|
|
"character": 42
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 1133,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1134,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 518,
|
|
"name": "LockFunc",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 519,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 23
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 520,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.",
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 526,
|
|
"name": "R",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 521,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Name of the lock to be acquired."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 522,
|
|
"name": "acquireTimeout",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 523,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operation to execute when the lock is acquired.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 524,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 69
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 525,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 526,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 526,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 934,
|
|
"name": "MFAChallengeAndVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 829,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 935,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 937,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 833,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 936,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being verified. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 831,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [937, 936]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 829,
|
|
"character": 42
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 930,
|
|
"name": "MFAChallengeParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 822,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 931,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 933,
|
|
"name": "channel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 826,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 932,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor to be challenged. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 824,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [933, 932]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 822,
|
|
"character": 33
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 921,
|
|
"name": "MFAEnrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 804,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 1078,
|
|
"name": "MFAEnrollTOTPParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1079,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1080,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1132,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 1082,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1136,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1081,
|
|
"name": "issuer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Domain which the user is enrolled with."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1134,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1080, 1082, 1081]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1083,
|
|
"name": "MFAEnrollPhoneParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1084,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1085,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1140,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 1086,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1142,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1087,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Phone number associated with a factor. Number should conform to E.164 format"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1144,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1085, 1086, 1087]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1083,
|
|
"name": "MFAEnrollPhoneParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1084,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1085,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1140,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "phone"
|
|
}
|
|
},
|
|
{
|
|
"id": 1086,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1142,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1087,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Phone number associated with a factor. Number should conform to E.164 format"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1144,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1085, 1086, 1087]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1138,
|
|
"character": 35
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1078,
|
|
"name": "MFAEnrollTOTPParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1079,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1080,
|
|
"name": "factorType",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The type of factor being enrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1132,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "totp"
|
|
}
|
|
},
|
|
{
|
|
"id": 1082,
|
|
"name": "friendlyName",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Human readable name assigned to the factor."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1136,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1081,
|
|
"name": "issuer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Domain which the user is enrolled with."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1134,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1080, 1082, 1081]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1130,
|
|
"character": 34
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 922,
|
|
"name": "MFAUnenrollParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 806,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 923,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 924,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being unenrolled."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 808,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [924]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 806,
|
|
"character": 32
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 925,
|
|
"name": "MFAVerifyParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 811,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 926,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 928,
|
|
"name": "challengeId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the challenge being verified. Returned in challenge()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 816,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 929,
|
|
"name": "code",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Verification code provided by the user."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 819,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 927,
|
|
"name": "factorId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "ID of the factor being verified. Returned in enroll()."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 813,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [928, 929, 927]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 811,
|
|
"character": 30
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 845,
|
|
"name": "MobileOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 662,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 624,
|
|
"name": "OAuthResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 179,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 625,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 626,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 181,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 627,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 628,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 182,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 515,
|
|
"name": "Provider"
|
|
}
|
|
},
|
|
{
|
|
"id": 629,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 183,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [628, 629]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 181,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 630,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 185,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [626, 630]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 180,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 631,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 632,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 188,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 633,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 634,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 189,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 515,
|
|
"name": "Provider"
|
|
}
|
|
},
|
|
{
|
|
"id": 635,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 190,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [634, 635]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 188,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 636,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 192,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [632, 636]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 187,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1071,
|
|
"name": "PageParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1109,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1072,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1073,
|
|
"name": "page",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The page number"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1111,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1074,
|
|
"name": "perPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Number of items returned per page"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1113,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1073, 1074]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1109,
|
|
"character": 25
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1064,
|
|
"name": "Pagination",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1102,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1065,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1067,
|
|
"name": "lastPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1105,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1066,
|
|
"name": "nextPage",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1104,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1068,
|
|
"name": "total",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1106,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1067, 1066, 1068]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1102,
|
|
"character": 25
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 1069,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1070,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 515,
|
|
"name": "Provider",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 5,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "apple"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "azure"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "bitbucket"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "discord"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "facebook"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "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": "workos"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "zoom"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "fly"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1121,
|
|
"name": "RequiredClaims",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1210,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1122,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1129,
|
|
"name": "aal",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1217,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 983,
|
|
"name": "AuthenticatorAssuranceLevels",
|
|
"dereferenced": {
|
|
"id": 983,
|
|
"name": "AuthenticatorAssuranceLevels",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 904,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "aal1"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "aal2"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1125,
|
|
"name": "aud",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1213,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1126,
|
|
"name": "exp",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1214,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1127,
|
|
"name": "iat",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1215,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1123,
|
|
"name": "iss",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1211,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1128,
|
|
"name": "role",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1216,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1130,
|
|
"name": "session_id",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1218,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1124,
|
|
"name": "sub",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1212,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1129, 1125, 1126, 1127, 1123, 1128, 1130, 1124]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1210,
|
|
"character": 29
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 847,
|
|
"name": "ResendParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 665,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 848,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 850,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 668,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 851,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 669,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 852,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 854,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 673,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 853,
|
|
"name": "emailRedirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they have signed-in."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 671,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [854, 853]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 669,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 849,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 667,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 846,
|
|
"name": "EmailOtpType"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Extract",
|
|
"package": "typescript",
|
|
"name": "Extract"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [850, 851, 849]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 666,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 855,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 858,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 679,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 859,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 860,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 681,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [860]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 679,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 857,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 678,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 856,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 677,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 845,
|
|
"name": "MobileOtpType"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Extract",
|
|
"package": "typescript",
|
|
"name": "Extract"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [858, 857, 856]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 676,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 637,
|
|
"name": "SSOResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 195,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 638,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 639,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 197,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 640,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 641,
|
|
"name": "url",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.",
|
|
"text": "On browsers you can set the URL to `window.location.href` to take\nthe user to the authentication flow.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 205,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [641]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 197,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 642,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 207,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [639, 642]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 196,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 643,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 644,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 210,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 645,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 211,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [644, 645]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 209,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 749,
|
|
"name": "SignInAnonymouslyCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 474,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 750,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 751,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 475,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 752,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 754,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 483,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 753,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 481,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [754, 753]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 475,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [751]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 474,
|
|
"character": 43
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 815,
|
|
"name": "SignInWithIdTokenCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 600,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 816,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 820,
|
|
"name": "access_token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 606,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 821,
|
|
"name": "nonce",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 608,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 822,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 609,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 823,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 824,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 611,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [824]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 609,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 817,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `kakao`, `keycloak` (deprecated)."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 2
|
|
}
|
|
],
|
|
"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": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 818,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 76
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 819,
|
|
"name": "token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 604,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [820, 821, 822, 817, 819]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 600,
|
|
"character": 43
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 803,
|
|
"name": "SignInWithOAuthCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 585,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 804,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 806,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 588,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 807,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 810,
|
|
"name": "queryParams",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "An object of query params"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 594,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 811,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 594,
|
|
"character": 18
|
|
}
|
|
],
|
|
"indexSignature": {
|
|
"id": 812,
|
|
"name": "__index",
|
|
"kind": 8192,
|
|
"kindString": "Index signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 813,
|
|
"name": "key",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 808,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 590,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 809,
|
|
"name": "scopes",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A space-separated list of scopes granted to the OAuth application."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 592,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 814,
|
|
"name": "skipBrowserRedirect",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 596,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [810, 808, 809, 814]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 588,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 805,
|
|
"name": "provider",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 587,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 515,
|
|
"name": "Provider",
|
|
"dereferenced": {
|
|
"id": 515,
|
|
"name": "Provider",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "One of the providers supported by GoTrue."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 5,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "apple"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "azure"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "bitbucket"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "discord"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "facebook"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "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": "workos"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "zoom"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "fly"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [806, 805]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 585,
|
|
"character": 41
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 772,
|
|
"name": "SignInWithPasswordCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 524,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 773,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 774,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 527,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 776,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 530,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 777,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 778,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 532,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [778]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 530,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 775,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 529,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [774, 776, 775]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 525,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 779,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 782,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 540,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 783,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 784,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 542,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [784]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 540,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 781,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 539,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 780,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 537,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [782, 781, 780]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 535,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 785,
|
|
"name": "SignInWithPasswordlessCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 546,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 786,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 787,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 549,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 788,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 550,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 789,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 793,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 562,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 792,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 560,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 790,
|
|
"name": "emailRedirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The redirect url embedded in the email link"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 552,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 791,
|
|
"name": "shouldCreateUser",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to false, this method will not create a new user. Defaults to true."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 554,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [793, 792, 790, 791]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 550,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [787, 788]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 547,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 794,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 796,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 568,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 797,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 800,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 578,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 801,
|
|
"name": "channel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Messaging channel to use (e.g. whatsapp or sms)"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 580,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 799,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 576,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 798,
|
|
"name": "shouldCreateUser",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to false, this method will not create a new user. Defaults to true."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 570,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [800, 801, 799, 798]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 568,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 795,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 567,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [796, 795]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 565,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 861,
|
|
"name": "SignInWithSSO",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 685,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 862,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 864,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 690,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 865,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 867,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 694,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 866,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they have signed-in."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 692,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [867, 866]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 690,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 863,
|
|
"name": "providerId",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "UUID of the SSO provider to invoke single-sign on to."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 688,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [864, 863]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 686,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 868,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 869,
|
|
"name": "domain",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Domain name of the organization for which to invoke single-sign on."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 699,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 870,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 701,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 871,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 873,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 705,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 872,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they have signed-in."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 703,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [873, 872]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 701,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [869, 870]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 697,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1075,
|
|
"name": "SignOut",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1116,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1076,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1077,
|
|
"name": "scope",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "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": "src/lib/types.ts",
|
|
"line": 1127,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "global"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "local"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "others"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1077]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1116,
|
|
"character": 22
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 755,
|
|
"name": "SignUpWithPasswordCredentials",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 487,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 756,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 757,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 490,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 759,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 493,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 760,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 763,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 503,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 762,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 501,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
},
|
|
{
|
|
"id": 761,
|
|
"name": "emailRedirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "The redirect url embedded in the email link"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 495,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [763, 762, 761]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 493,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 758,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 492,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [757, 759, 758]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 488,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 764,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 767,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 511,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 768,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 770,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 519,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 771,
|
|
"name": "channel",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Messaging channel to use (e.g. whatsapp or sms)"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 521,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "whatsapp"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 769,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.",
|
|
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 517,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [770, 771, 769]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 511,
|
|
"character": 16
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 766,
|
|
"name": "password",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's password."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 510,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 765,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 508,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [767, 766, 765]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 506,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1051,
|
|
"name": "SupportedStorage",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1077,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"qualifiedName": "Storage",
|
|
"package": "typescript",
|
|
"name": "Storage"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "getItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "setItem"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "removeItem"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"qualifiedName": "Pick",
|
|
"package": "typescript",
|
|
"name": "Pick"
|
|
}
|
|
],
|
|
"name": "PromisifyMethods"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1052,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1053,
|
|
"name": "isServer",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "If set to `true` 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": "src/lib/types.ts",
|
|
"line": 1087,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [1053]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 1079,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "UserResponse",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 214,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 647,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 648,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 216,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 649,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 650,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 217,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 697,
|
|
"name": "User"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [650]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 216,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 651,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 219,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [648, 651]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 215,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 652,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 653,
|
|
"name": "data",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 222,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 654,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 655,
|
|
"name": "user",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 223,
|
|
"character": 8
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [655]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 222,
|
|
"character": 12
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 656,
|
|
"name": "error",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 225,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [653, 656]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 221,
|
|
"character": 4
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 825,
|
|
"name": "VerifyOtpParams",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 615,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"id": 826,
|
|
"name": "VerifyMobileOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 830,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 623,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 831,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 833,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site.",
|
|
"tags": [
|
|
{
|
|
"tag": "deprecated",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 632,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 832,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 625,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [833, 832]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 827,
|
|
"name": "phone",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 618,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 828,
|
|
"name": "token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The otp sent to the user's phone number."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 620,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 829,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 622,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 845,
|
|
"name": "MobileOtpType",
|
|
"dereferenced": {
|
|
"id": 845,
|
|
"name": "MobileOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 662,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "sms"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phone_change"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [830, 827, 828, 829]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 616,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 834,
|
|
"name": "VerifyEmailOtpParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 835,
|
|
"name": "email",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 637,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 838,
|
|
"name": "options",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 642,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 839,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 841,
|
|
"name": "captchaToken",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "Verification token received when the user completes the captcha on the site.",
|
|
"tags": [
|
|
{
|
|
"tag": "deprecated",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 650,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 840,
|
|
"name": "redirectTo",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"shortText": "A URL to send the user to after they are confirmed."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 644,
|
|
"character": 4
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [841, 840]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 836,
|
|
"name": "token",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The otp sent to the user's email address."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 639,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 837,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 641,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [835, 838, 836, 837]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 635,
|
|
"character": 17
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 842,
|
|
"name": "VerifyTokenHashParams",
|
|
"kind": 256,
|
|
"kindString": "Interface",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 843,
|
|
"name": "token_hash",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The token hash used in an email link"
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 656,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 844,
|
|
"name": "type",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The user's verification type."
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 659,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"dereferenced": {
|
|
"id": 846,
|
|
"name": "EmailOtpType",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 663,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "signup"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "invite"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "magiclink"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "recovery"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email_change"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "email"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [843, 844]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 654,
|
|
"character": 17
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 550,
|
|
"name": "WeakPassword",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 92,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 551,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 553,
|
|
"name": "message",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 94,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 552,
|
|
"name": "reasons",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 93,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"id": 548,
|
|
"name": "WeakPasswordReasons"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [553, 552]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 92,
|
|
"character": 27
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 548,
|
|
"name": "WeakPasswordReasons",
|
|
"kind": 4194304,
|
|
"kindString": "Type alias",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 91,
|
|
"character": 12
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "length"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "characters"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "pwned"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 549,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/types.ts",
|
|
"line": 91,
|
|
"character": 80
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 497,
|
|
"name": "AuthAdminApi",
|
|
"kind": 32,
|
|
"kindString": "Variable",
|
|
"flags": {
|
|
"isConst": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/AuthAdminApi.ts",
|
|
"line": 3,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "query",
|
|
"queryType": {
|
|
"type": "reference",
|
|
"id": 1,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "GoTrueAdminApi"
|
|
},
|
|
{
|
|
"id": 498,
|
|
"name": "AuthClient",
|
|
"kind": 32,
|
|
"kindString": "Variable",
|
|
"flags": {
|
|
"isConst": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/AuthClient.ts",
|
|
"line": 3,
|
|
"character": 6
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "query",
|
|
"queryType": {
|
|
"type": "reference",
|
|
"id": 78,
|
|
"name": "default"
|
|
}
|
|
},
|
|
"defaultValue": "GoTrueClient"
|
|
},
|
|
{
|
|
"id": 512,
|
|
"name": "lockInternals",
|
|
"kind": 32,
|
|
"kindString": "Variable",
|
|
"flags": {
|
|
"isConst": true
|
|
},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/locks.ts",
|
|
"line": 6,
|
|
"character": 13
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 513,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 514,
|
|
"name": "debug",
|
|
"kind": 1024,
|
|
"kindString": "Property",
|
|
"flags": {},
|
|
"comment": {
|
|
"tags": [
|
|
{
|
|
"tag": "experimental",
|
|
"text": "\n"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/locks.ts",
|
|
"line": 10,
|
|
"character": 2
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "!!(\n globalThis &&\n supportsLocalStorage() &&\n globalThis.localStorage &&\n globalThis.localStorage.getItem('supabase.gotrue-js.locks.debug') === 'true'\n )"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"kind": 1024,
|
|
"children": [514]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1145,
|
|
"name": "isAuthApiError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 41,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1146,
|
|
"name": "isAuthApiError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1147,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1170,
|
|
"name": "AuthApiError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1142,
|
|
"name": "isAuthError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 26,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1143,
|
|
"name": "isAuthError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1144,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1160,
|
|
"name": "AuthError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1151,
|
|
"name": "isAuthImplicitGrantRedirectError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 105,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1152,
|
|
"name": "isAuthImplicitGrantRedirectError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1153,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1227,
|
|
"name": "AuthImplicitGrantRedirectError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1154,
|
|
"name": "isAuthRetryableFetchError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 135,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1155,
|
|
"name": "isAuthRetryableFetchError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1156,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1281,
|
|
"name": "AuthRetryableFetchError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1148,
|
|
"name": "isAuthSessionMissingError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 72,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1149,
|
|
"name": "isAuthSessionMissingError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1150,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1202,
|
|
"name": "AuthSessionMissingError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1157,
|
|
"name": "isAuthWeakPasswordError",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/errors.ts",
|
|
"line": 157,
|
|
"character": 16
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1158,
|
|
"name": "isAuthWeakPasswordError",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"parameters": [
|
|
{
|
|
"id": 1159,
|
|
"name": "error",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"id": 1291,
|
|
"name": "AuthWeakPasswordError"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 499,
|
|
"name": "navigatorLock",
|
|
"kind": 64,
|
|
"kindString": "Function",
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "src/lib/locks.ts",
|
|
"line": 59,
|
|
"character": 22
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 500,
|
|
"name": "navigatorLock",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 {@link\nGoTrueClient}.",
|
|
"text": "You can turn on debugging by setting the `supabase.gotrue-js.locks.debug`\nlocal storage item to `true`.\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the `request` method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the `fn`\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway.\n"
|
|
},
|
|
"typeParameter": [
|
|
{
|
|
"id": 501,
|
|
"name": "R",
|
|
"kind": 131072,
|
|
"kindString": "Type parameter",
|
|
"flags": {}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 502,
|
|
"name": "name",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "Name of the lock to be acquired."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 503,
|
|
"name": "acquireTimeout",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "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 `isAcquireTimeout` set to true."
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 504,
|
|
"name": "fn",
|
|
"kind": 32768,
|
|
"kindString": "Parameter",
|
|
"flags": {},
|
|
"comment": {
|
|
"shortText": "The operation to run once the lock is acquired.\n"
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 505,
|
|
"name": "__type",
|
|
"kind": 65536,
|
|
"kindString": "Type literal",
|
|
"flags": {},
|
|
"signatures": [
|
|
{
|
|
"id": 506,
|
|
"name": "__type",
|
|
"kind": 4096,
|
|
"kindString": "Call signature",
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 501,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"id": 501,
|
|
"name": "R"
|
|
}
|
|
],
|
|
"qualifiedName": "Promise",
|
|
"package": "typescript",
|
|
"name": "Promise"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"kind": 128,
|
|
"children": [
|
|
1170, 1160, 1227, 1218, 1303, 1210, 1254, 1281, 1202, 1180, 1291, 1190, 1, 78, 507
|
|
]
|
|
},
|
|
{
|
|
"title": "Interfaces",
|
|
"kind": 256,
|
|
"children": [
|
|
666, 728, 682, 896, 1044, 995, 1135, 657, 741, 697, 690, 722, 670, 694, 834, 826, 842
|
|
]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"kind": 4194304,
|
|
"children": [
|
|
517, 516, 802, 1028, 1019, 1041, 1032, 961, 1104, 951, 1088, 984, 972, 952, 938, 581, 554,
|
|
567, 596, 609, 983, 1057, 846, 890, 880, 899, 913, 900, 920, 885, 874, 527, 1054, 1116,
|
|
1131, 518, 934, 930, 921, 1083, 1078, 922, 925, 845, 624, 1071, 1064, 515, 1121, 847, 637,
|
|
749, 815, 803, 772, 785, 861, 1075, 755, 1051, 646, 825, 550, 548
|
|
]
|
|
},
|
|
{
|
|
"title": "Variables",
|
|
"kind": 32,
|
|
"children": [497, 498, 512]
|
|
},
|
|
{
|
|
"title": "Functions",
|
|
"kind": 64,
|
|
"children": [1145, 1142, 1151, 1154, 1148, 1157, 499]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "src/index.ts",
|
|
"line": 1,
|
|
"character": 0
|
|
}
|
|
]
|
|
}
|