From 8ade6270cc4b66bfec4c6989edfba4af65f9ea8a Mon Sep 17 00:00:00 2001 From: Kang Ming Date: Wed, 24 May 2023 02:07:31 +0800 Subject: [PATCH 1/4] update reference docs --- spec/enrichments/tsdoc_v2/combined.json | 14675 ++++--- spec/enrichments/tsdoc_v2/functions.json | 2581 +- .../tsdoc_v2/functions_dereferenced.json | 84 +- spec/enrichments/tsdoc_v2/gotrue.json | 31892 ++++++++-------- .../tsdoc_v2/gotrue_dereferenced.json | 11560 +++--- spec/enrichments/tsdoc_v2/postgrest.json | 26635 ++++++------- .../tsdoc_v2/postgrest_dereferenced.json | 666 +- spec/enrichments/tsdoc_v2/realtime.json | 12795 ++++--- .../tsdoc_v2/realtime_dereferenced.json | 1529 +- spec/enrichments/tsdoc_v2/storage.json | 15654 ++++---- .../tsdoc_v2/storage_dereferenced.json | 589 +- spec/enrichments/tsdoc_v2/supabase.json | 8319 ++-- .../tsdoc_v2/supabase_dereferenced.json | 269 +- 13 files changed, 68536 insertions(+), 58712 deletions(-) diff --git a/spec/enrichments/tsdoc_v2/combined.json b/spec/enrichments/tsdoc_v2/combined.json index 7cb258eaa40..3c5fe603f27 100644 --- a/spec/enrichments/tsdoc_v2/combined.json +++ b/spec/enrichments/tsdoc_v2/combined.json @@ -436,7 +436,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -503,7 +510,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -628,7 +637,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -671,7 +683,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -2143,7 +2160,10 @@ { "title": "Properties", "kind": 1024, - "children": [158, 157] + "children": [ + 158, + 157 + ] } ] } @@ -2261,22 +2281,53 @@ { "title": "Constructors", "kind": 512, - "children": [106] + "children": [ + 106 + ] }, { "title": "Properties", "kind": 1024, - "children": [114, 117, 127, 122, 119, 128, 115, 116, 120, 121, 118, 133, 132] + "children": [ + 114, + 117, + 127, + 122, + 119, + 128, + 115, + 116, + 120, + 121, + 118, + 133, + 132 + ] }, { "title": "Accessors", "kind": 262144, - "children": [134, 136] + "children": [ + 134, + 136 + ] }, { "title": "Methods", "kind": 2048, - "children": [170, 187, 181, 172, 184, 159, 138, 163, 168, 165, 149] + "children": [ + 170, + 187, + 181, + 172, + 184, + 159, + 138, + 163, + 168, + 165, + 149 + ] } ], "sources": [ @@ -2802,7 +2853,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -2869,7 +2927,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -2994,7 +3054,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -3037,7 +3100,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -3083,17 +3151,23 @@ { "title": "References", "kind": 16777216, - "children": [195] + "children": [ + 195 + ] }, { "title": "Classes", "kind": 128, - "children": [105] + "children": [ + 105 + ] }, { "title": "Functions", "kind": 64, - "children": [2] + "children": [ + 2 + ] } ], "sources": [ @@ -3159,7 +3233,9 @@ { "title": "Properties", "kind": 1024, - "children": [13] + "children": [ + 13 + ] } ] } @@ -3171,7 +3247,9 @@ { "title": "Variables", "kind": 32, - "children": [11] + "children": [ + 11 + ] } ], "sources": [ @@ -3649,7 +3727,11 @@ { "title": "Functions", "kind": 64, - "children": [29, 15, 26] + "children": [ + 29, + 15, + 26 + ] } ], "sources": [ @@ -3981,7 +4063,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -4048,7 +4137,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -4173,7 +4264,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -4216,7 +4310,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -4461,7 +4560,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -4528,7 +4634,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -4653,7 +4761,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -4696,7 +4807,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -4826,7 +4942,12 @@ { "title": "Functions", "kind": 64, - "children": [50, 56, 47, 45] + "children": [ + 50, + 56, + 47, + 45 + ] } ], "sources": [ @@ -4963,7 +5084,10 @@ { "title": "Properties", "kind": 1024, - "children": [96, 97] + "children": [ + 96, + 97 + ] } ], "sources": [ @@ -5033,7 +5157,9 @@ { "title": "Properties", "kind": 1024, - "children": [92] + "children": [ + 92 + ] } ], "sources": [ @@ -5166,7 +5292,11 @@ { "title": "Properties", "kind": 1024, - "children": [102, 100, 101] + "children": [ + 102, + 100, + 101 + ] } ], "sources": [ @@ -5296,7 +5426,11 @@ { "title": "Properties", "kind": 1024, - "children": [83, 82, 84] + "children": [ + 83, + 82, + 84 + ] } ], "sources": [ @@ -5426,7 +5560,11 @@ { "title": "Properties", "kind": 1024, - "children": [88, 87, 89] + "children": [ + 88, + 87, + 89 + ] } ], "sources": [ @@ -5572,7 +5710,11 @@ { "title": "Properties", "kind": 1024, - "children": [88, 87, 89] + "children": [ + 88, + 87, + 89 + ] } ], "sources": [ @@ -5642,7 +5784,9 @@ { "title": "Properties", "kind": 1024, - "children": [92] + "children": [ + 92 + ] } ], "sources": [ @@ -5872,7 +6016,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -5939,7 +6090,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -6064,7 +6217,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -6107,7 +6263,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -6125,12 +6286,23 @@ { "title": "Interfaces", "kind": 256, - "children": [59] + "children": [ + 59 + ] }, { "title": "Type Aliases", "kind": 4194304, - "children": [60, 94, 90, 98, 80, 85, 93, 61] + "children": [ + 60, + 94, + 90, + 98, + 80, + 85, + 93, + 61 + ] } ], "sources": [ @@ -6174,7 +6346,9 @@ { "title": "Variables", "kind": 32, - "children": [104] + "children": [ + 104 + ] } ], "sources": [ @@ -6190,7 +6364,14 @@ { "title": "Modules", "kind": 2, - "children": [1, 10, 14, 44, 58, 103] + "children": [ + 1, + 10, + 14, + 44, + 58, + 103 + ] } ] }, @@ -6203,14 +6384,14 @@ "originalName": "", "children": [ { - "id": 791, + "id": 811, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 792, + "id": 812, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -6224,14 +6405,14 @@ ], "signatures": [ { - "id": 793, + "id": 813, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 794, + "id": 814, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -6242,7 +6423,7 @@ } }, { - "id": 795, + "id": 815, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -6255,24 +6436,24 @@ ], "type": { "type": "reference", - "id": 791, + "id": 811, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 786, + "id": 806, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 785, + "id": 805, "name": "AuthError.constructor" } }, { - "id": 796, + "id": 816, "name": "status", "kind": 1024, "kindString": "Property", @@ -6290,12 +6471,12 @@ }, "overwrites": { "type": "reference", - "id": 789, + "id": 809, "name": "AuthError.status" } }, { - "id": 797, + "id": 817, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -6309,7 +6490,7 @@ ], "signatures": [ { - "id": 798, + "id": 818, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -6317,14 +6498,14 @@ "type": { "type": "reflection", "declaration": { - "id": 799, + "id": 819, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 801, + "id": 821, "name": "message", "kind": 1024, "kindString": "Property", @@ -6343,7 +6524,7 @@ "defaultValue": "..." }, { - "id": 800, + "id": 820, "name": "name", "kind": 1024, "kindString": "Property", @@ -6362,7 +6543,7 @@ "defaultValue": "..." }, { - "id": 802, + "id": 822, "name": "status", "kind": 1024, "kindString": "Property", @@ -6385,7 +6566,11 @@ { "title": "Properties", "kind": 1024, - "children": [801, 800, 802] + "children": [ + 821, + 820, + 822 + ] } ] } @@ -6398,17 +6583,23 @@ { "title": "Constructors", "kind": 512, - "children": [792] + "children": [ + 812 + ] }, { "title": "Properties", "kind": 1024, - "children": [796] + "children": [ + 816 + ] }, { "title": "Methods", "kind": 2048, - "children": [797] + "children": [ + 817 + ] } ], "sources": [ @@ -6421,20 +6612,20 @@ "extendedTypes": [ { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] }, { - "id": 784, + "id": 804, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 785, + "id": 805, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -6448,14 +6639,14 @@ ], "signatures": [ { - "id": 786, + "id": 806, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 787, + "id": 807, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -6466,7 +6657,7 @@ } }, { - "id": 788, + "id": 808, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -6481,7 +6672,7 @@ ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" }, "overwrites": { @@ -6496,7 +6687,7 @@ } }, { - "id": 789, + "id": 809, "name": "status", "kind": 1024, "kindString": "Property", @@ -6527,12 +6718,16 @@ { "title": "Constructors", "kind": 512, - "children": [785] + "children": [ + 805 + ] }, { "title": "Properties", "kind": 1024, - "children": [789] + "children": [ + 809 + ] } ], "sources": [ @@ -6553,30 +6748,30 @@ "extendedBy": [ { "type": "reference", - "id": 791, + "id": 811, "name": "AuthApiError" }, { "type": "reference", - "id": 804, + "id": 824, "name": "AuthUnknownError" }, { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 852, + "id": 872, "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 853, + "id": 873, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -6590,14 +6785,14 @@ ], "signatures": [ { - "id": 854, + "id": 874, "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 855, + "id": 875, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -6608,7 +6803,7 @@ } }, { - "id": 856, + "id": 876, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -6623,14 +6818,14 @@ { "type": "reflection", "declaration": { - "id": 857, + "id": 877, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 859, + "id": 879, "name": "code", "kind": 1024, "kindString": "Property", @@ -6648,7 +6843,7 @@ } }, { - "id": 858, + "id": 878, "name": "error", "kind": 1024, "kindString": "Property", @@ -6670,7 +6865,10 @@ { "title": "Properties", "kind": 1024, - "children": [859, 858] + "children": [ + 879, + 878 + ] } ] } @@ -6682,24 +6880,24 @@ ], "type": { "type": "reference", - "id": 852, + "id": 872, "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 860, + "id": 880, "name": "details", "kind": 1024, "kindString": "Property", @@ -6721,14 +6919,14 @@ { "type": "reflection", "declaration": { - "id": 861, + "id": 881, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 863, + "id": 883, "name": "code", "kind": 1024, "kindString": "Property", @@ -6746,7 +6944,7 @@ } }, { - "id": 862, + "id": 882, "name": "error", "kind": 1024, "kindString": "Property", @@ -6768,7 +6966,10 @@ { "title": "Properties", "kind": 1024, - "children": [863, 862] + "children": [ + 883, + 882 + ] } ] } @@ -6778,7 +6979,7 @@ "defaultValue": "null" }, { - "id": 874, + "id": 894, "name": "name", "kind": 1024, "kindString": "Property", @@ -6796,12 +6997,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 875, + "id": 895, "name": "status", "kind": 1024, "kindString": "Property", @@ -6819,12 +7020,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 864, + "id": 884, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -6838,7 +7039,7 @@ ], "signatures": [ { - "id": 865, + "id": 885, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -6846,14 +7047,14 @@ "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 886, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 890, "name": "details", "kind": 1024, "kindString": "Property", @@ -6875,14 +7076,14 @@ { "type": "reflection", "declaration": { - "id": 871, + "id": 891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 873, + "id": 893, "name": "code", "kind": 1024, "kindString": "Property", @@ -6900,7 +7101,7 @@ } }, { - "id": 872, + "id": 892, "name": "error", "kind": 1024, "kindString": "Property", @@ -6922,7 +7123,10 @@ { "title": "Properties", "kind": 1024, - "children": [873, 872] + "children": [ + 893, + 892 + ] } ] } @@ -6932,7 +7136,7 @@ "defaultValue": "..." }, { - "id": 868, + "id": 888, "name": "message", "kind": 1024, "kindString": "Property", @@ -6951,7 +7155,7 @@ "defaultValue": "..." }, { - "id": 867, + "id": 887, "name": "name", "kind": 1024, "kindString": "Property", @@ -6970,7 +7174,7 @@ "defaultValue": "..." }, { - "id": 869, + "id": 889, "name": "status", "kind": 1024, "kindString": "Property", @@ -6993,21 +7197,26 @@ { "title": "Properties", "kind": 1024, - "children": [870, 868, 867, 869] + "children": [ + 890, + 888, + 887, + 889 + ] } ] } }, "overwrites": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "overwrites": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -7016,17 +7225,25 @@ { "title": "Constructors", "kind": 512, - "children": [853] + "children": [ + 873 + ] }, { "title": "Properties", "kind": 1024, - "children": [860, 874, 875] + "children": [ + 880, + 894, + 895 + ] }, { "title": "Methods", "kind": 2048, - "children": [864] + "children": [ + 884 + ] } ], "sources": [ @@ -7039,20 +7256,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 839, + "id": 859, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 840, + "id": 860, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7066,14 +7283,14 @@ ], "signatures": [ { - "id": 841, + "id": 861, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 842, + "id": 862, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -7086,24 +7303,24 @@ ], "type": { "type": "reference", - "id": 839, + "id": 859, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 843, + "id": 863, "name": "name", "kind": 1024, "kindString": "Property", @@ -7121,12 +7338,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 844, + "id": 864, "name": "status", "kind": 1024, "kindString": "Property", @@ -7144,12 +7361,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 845, + "id": 865, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -7163,7 +7380,7 @@ ], "signatures": [ { - "id": 846, + "id": 866, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -7171,14 +7388,14 @@ "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 867, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 869, "name": "message", "kind": 1024, "kindString": "Property", @@ -7197,7 +7414,7 @@ "defaultValue": "..." }, { - "id": 848, + "id": 868, "name": "name", "kind": 1024, "kindString": "Property", @@ -7216,7 +7433,7 @@ "defaultValue": "..." }, { - "id": 850, + "id": 870, "name": "status", "kind": 1024, "kindString": "Property", @@ -7239,21 +7456,25 @@ { "title": "Properties", "kind": 1024, - "children": [849, 848, 850] + "children": [ + 869, + 868, + 870 + ] } ] } }, "inheritedFrom": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -7262,17 +7483,24 @@ { "title": "Constructors", "kind": 512, - "children": [840] + "children": [ + 860 + ] }, { "title": "Properties", "kind": 1024, - "children": [843, 844] + "children": [ + 863, + 864 + ] }, { "title": "Methods", "kind": 2048, - "children": [845] + "children": [ + 865 + ] } ], "sources": [ @@ -7285,20 +7513,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 877, + "id": 897, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 878, + "id": 898, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7312,14 +7540,14 @@ ], "signatures": [ { - "id": 879, + "id": 899, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 880, + "id": 900, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -7330,7 +7558,7 @@ } }, { - "id": 881, + "id": 901, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -7345,14 +7573,14 @@ { "type": "reflection", "declaration": { - "id": 882, + "id": 902, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 884, + "id": 904, "name": "code", "kind": 1024, "kindString": "Property", @@ -7370,7 +7598,7 @@ } }, { - "id": 883, + "id": 903, "name": "error", "kind": 1024, "kindString": "Property", @@ -7392,7 +7620,10 @@ { "title": "Properties", "kind": 1024, - "children": [884, 883] + "children": [ + 904, + 903 + ] } ] } @@ -7404,24 +7635,24 @@ ], "type": { "type": "reference", - "id": 877, + "id": 897, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 885, + "id": 905, "name": "details", "kind": 1024, "kindString": "Property", @@ -7443,14 +7674,14 @@ { "type": "reflection", "declaration": { - "id": 886, + "id": 906, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 888, + "id": 908, "name": "code", "kind": 1024, "kindString": "Property", @@ -7468,7 +7699,7 @@ } }, { - "id": 887, + "id": 907, "name": "error", "kind": 1024, "kindString": "Property", @@ -7490,7 +7721,10 @@ { "title": "Properties", "kind": 1024, - "children": [888, 887] + "children": [ + 908, + 907 + ] } ] } @@ -7500,7 +7734,7 @@ "defaultValue": "null" }, { - "id": 899, + "id": 919, "name": "name", "kind": 1024, "kindString": "Property", @@ -7518,12 +7752,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 900, + "id": 920, "name": "status", "kind": 1024, "kindString": "Property", @@ -7541,12 +7775,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 889, + "id": 909, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -7560,7 +7794,7 @@ ], "signatures": [ { - "id": 890, + "id": 910, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -7568,14 +7802,14 @@ "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 911, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 895, + "id": 915, "name": "details", "kind": 1024, "kindString": "Property", @@ -7597,14 +7831,14 @@ { "type": "reflection", "declaration": { - "id": 896, + "id": 916, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 898, + "id": 918, "name": "code", "kind": 1024, "kindString": "Property", @@ -7622,7 +7856,7 @@ } }, { - "id": 897, + "id": 917, "name": "error", "kind": 1024, "kindString": "Property", @@ -7644,7 +7878,10 @@ { "title": "Properties", "kind": 1024, - "children": [898, 897] + "children": [ + 918, + 917 + ] } ] } @@ -7654,7 +7891,7 @@ "defaultValue": "..." }, { - "id": 893, + "id": 913, "name": "message", "kind": 1024, "kindString": "Property", @@ -7673,7 +7910,7 @@ "defaultValue": "..." }, { - "id": 892, + "id": 912, "name": "name", "kind": 1024, "kindString": "Property", @@ -7692,7 +7929,7 @@ "defaultValue": "..." }, { - "id": 894, + "id": 914, "name": "status", "kind": 1024, "kindString": "Property", @@ -7715,21 +7952,26 @@ { "title": "Properties", "kind": 1024, - "children": [895, 893, 892, 894] + "children": [ + 915, + 913, + 912, + 914 + ] } ] } }, "overwrites": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "overwrites": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -7738,17 +7980,25 @@ { "title": "Constructors", "kind": 512, - "children": [878] + "children": [ + 898 + ] }, { "title": "Properties", "kind": 1024, - "children": [885, 899, 900] + "children": [ + 905, + 919, + 920 + ] }, { "title": "Methods", "kind": 2048, - "children": [889] + "children": [ + 909 + ] } ], "sources": [ @@ -7761,20 +8011,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 902, + "id": 922, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 903, + "id": 923, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7788,14 +8038,14 @@ ], "signatures": [ { - "id": 904, + "id": 924, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 905, + "id": 925, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -7806,7 +8056,7 @@ } }, { - "id": 906, + "id": 926, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -7819,24 +8069,24 @@ ], "type": { "type": "reference", - "id": 902, + "id": 922, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 907, + "id": 927, "name": "name", "kind": 1024, "kindString": "Property", @@ -7854,12 +8104,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 908, + "id": 928, "name": "status", "kind": 1024, "kindString": "Property", @@ -7877,12 +8127,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 909, + "id": 929, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -7896,7 +8146,7 @@ ], "signatures": [ { - "id": 910, + "id": 930, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -7904,14 +8154,14 @@ "type": { "type": "reflection", "declaration": { - "id": 911, + "id": 931, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 933, "name": "message", "kind": 1024, "kindString": "Property", @@ -7930,7 +8180,7 @@ "defaultValue": "..." }, { - "id": 912, + "id": 932, "name": "name", "kind": 1024, "kindString": "Property", @@ -7949,7 +8199,7 @@ "defaultValue": "..." }, { - "id": 914, + "id": 934, "name": "status", "kind": 1024, "kindString": "Property", @@ -7972,21 +8222,25 @@ { "title": "Properties", "kind": 1024, - "children": [913, 912, 914] + "children": [ + 933, + 932, + 934 + ] } ] } }, "inheritedFrom": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -7995,17 +8249,24 @@ { "title": "Constructors", "kind": 512, - "children": [903] + "children": [ + 923 + ] }, { "title": "Properties", "kind": 1024, - "children": [907, 908] + "children": [ + 927, + 928 + ] }, { "title": "Methods", "kind": 2048, - "children": [909] + "children": [ + 929 + ] } ], "sources": [ @@ -8018,20 +8279,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 827, + "id": 847, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 828, + "id": 848, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8045,31 +8306,31 @@ ], "signatures": [ { - "id": 829, + "id": 849, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 827, + "id": 847, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 830, + "id": 850, "name": "name", "kind": 1024, "kindString": "Property", @@ -8087,12 +8348,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 831, + "id": 851, "name": "status", "kind": 1024, "kindString": "Property", @@ -8110,12 +8371,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 832, + "id": 852, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -8129,7 +8390,7 @@ ], "signatures": [ { - "id": 833, + "id": 853, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -8137,14 +8398,14 @@ "type": { "type": "reflection", "declaration": { - "id": 834, + "id": 854, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 836, + "id": 856, "name": "message", "kind": 1024, "kindString": "Property", @@ -8163,7 +8424,7 @@ "defaultValue": "..." }, { - "id": 835, + "id": 855, "name": "name", "kind": 1024, "kindString": "Property", @@ -8182,7 +8443,7 @@ "defaultValue": "..." }, { - "id": 837, + "id": 857, "name": "status", "kind": 1024, "kindString": "Property", @@ -8205,21 +8466,25 @@ { "title": "Properties", "kind": 1024, - "children": [836, 835, 837] + "children": [ + 856, + 855, + 857 + ] } ] } }, "inheritedFrom": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -8228,17 +8493,24 @@ { "title": "Constructors", "kind": 512, - "children": [828] + "children": [ + 848 + ] }, { "title": "Properties", "kind": 1024, - "children": [830, 831] + "children": [ + 850, + 851 + ] }, { "title": "Methods", "kind": 2048, - "children": [832] + "children": [ + 852 + ] } ], "sources": [ @@ -8251,20 +8523,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 804, + "id": 824, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 805, + "id": 825, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8278,14 +8550,14 @@ ], "signatures": [ { - "id": 806, + "id": 826, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 807, + "id": 827, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -8296,7 +8568,7 @@ } }, { - "id": 808, + "id": 828, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -8309,24 +8581,24 @@ ], "type": { "type": "reference", - "id": 804, + "id": 824, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 786, + "id": 806, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 785, + "id": 805, "name": "AuthError.constructor" } }, { - "id": 809, + "id": 829, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -8344,7 +8616,7 @@ } }, { - "id": 810, + "id": 830, "name": "status", "kind": 1024, "kindString": "Property", @@ -8371,7 +8643,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 789, + "id": 809, "name": "AuthError.status" } } @@ -8380,12 +8652,17 @@ { "title": "Constructors", "kind": 512, - "children": [805] + "children": [ + 825 + ] }, { "title": "Properties", "kind": 1024, - "children": [809, 810] + "children": [ + 829, + 830 + ] } ], "sources": [ @@ -8398,20 +8675,20 @@ "extendedTypes": [ { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] }, { - "id": 812, + "id": 832, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 813, + "id": 833, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8425,14 +8702,14 @@ ], "signatures": [ { - "id": 814, + "id": 834, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 815, + "id": 835, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -8443,7 +8720,7 @@ } }, { - "id": 816, + "id": 836, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -8454,7 +8731,7 @@ } }, { - "id": 817, + "id": 837, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -8467,24 +8744,24 @@ ], "type": { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 786, + "id": 806, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 785, + "id": 805, "name": "AuthError.constructor" } }, { - "id": 818, + "id": 838, "name": "name", "kind": 1024, "kindString": "Property", @@ -8506,7 +8783,7 @@ } }, { - "id": 819, + "id": 839, "name": "status", "kind": 1024, "kindString": "Property", @@ -8524,12 +8801,12 @@ }, "overwrites": { "type": "reference", - "id": 789, + "id": 809, "name": "AuthError.status" } }, { - "id": 820, + "id": 840, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -8543,7 +8820,7 @@ ], "signatures": [ { - "id": 821, + "id": 841, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -8551,14 +8828,14 @@ "type": { "type": "reflection", "declaration": { - "id": 822, + "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 824, + "id": 844, "name": "message", "kind": 1024, "kindString": "Property", @@ -8577,7 +8854,7 @@ "defaultValue": "..." }, { - "id": 823, + "id": 843, "name": "name", "kind": 1024, "kindString": "Property", @@ -8596,7 +8873,7 @@ "defaultValue": "..." }, { - "id": 825, + "id": 845, "name": "status", "kind": 1024, "kindString": "Property", @@ -8619,7 +8896,11 @@ { "title": "Properties", "kind": 1024, - "children": [824, 823, 825] + "children": [ + 844, + 843, + 845 + ] } ] } @@ -8632,17 +8913,24 @@ { "title": "Constructors", "kind": 512, - "children": [813] + "children": [ + 833 + ] }, { "title": "Properties", "kind": 1024, - "children": [818, 819] + "children": [ + 838, + 839 + ] }, { "title": "Methods", "kind": 2048, - "children": [820] + "children": [ + 840 + ] } ], "sources": [ @@ -8655,34 +8943,34 @@ "extendedTypes": [ { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 827, + "id": 847, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 839, + "id": 859, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 852, + "id": 872, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 877, + "id": 897, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 902, + "id": 922, "name": "AuthRetryableFetchError" } ] @@ -8892,7 +9180,11 @@ { "title": "Properties", "kind": 1024, - "children": [11, 7, 6] + "children": [ + 11, + 7, + 6 + ] } ] } @@ -8925,10 +9217,10 @@ ], "type": { "type": "reference", - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -8944,14 +9236,14 @@ }, "children": [ { - "id": 753, + "id": 773, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 754, + "id": 774, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -8971,17 +9263,17 @@ }, "parameters": [ { - "id": 755, + "id": 775, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -8997,21 +9289,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "id", "kind": 1024, "kindString": "Property", @@ -9022,7 +9314,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 870, + "line": 896, "character": 2 } ], @@ -9032,7 +9324,7 @@ } }, { - "id": 736, + "id": 756, "name": "userId", "kind": 1024, "kindString": "Property", @@ -9043,7 +9335,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 873, + "line": 899, "character": 2 } ], @@ -9057,13 +9349,16 @@ { "title": "Properties", "kind": 1024, - "children": [735, 736] + "children": [ + 755, + 756 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 45 } ] @@ -9078,7 +9373,7 @@ "typeArguments": [ { "type": "reference", - "id": 724, + "id": 744, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -9090,14 +9385,14 @@ ] }, { - "id": 750, + "id": 770, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 751, + "id": 771, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -9107,17 +9402,17 @@ }, "parameters": [ { - "id": 752, + "id": 772, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -9133,21 +9428,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 747, + "id": 767, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 768, "name": "userId", "kind": 1024, "kindString": "Property", @@ -9158,7 +9453,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 920, "character": 2 } ], @@ -9172,13 +9467,15 @@ { "title": "Properties", "kind": 1024, - "children": [748] + "children": [ + 768 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 44 } ] @@ -9193,7 +9490,7 @@ "typeArguments": [ { "type": "reference", - "id": 737, + "id": 757, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -9209,13 +9506,16 @@ { "title": "Methods", "kind": 2048, - "children": [753, 750] + "children": [ + 773, + 770 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 902, + "line": 928, "character": 17 } ] @@ -9231,7 +9531,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 146, + "line": 148, "character": 8 } ], @@ -9254,17 +9554,17 @@ "flags": {}, "type": { "type": "reference", - "id": 448, + "id": 454, "name": "AdminUserAttributes", "dereferenced": { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -9278,7 +9578,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -9288,7 +9588,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -9302,7 +9602,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -9312,7 +9612,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -9325,7 +9625,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -9339,7 +9639,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -9353,7 +9653,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -9363,7 +9663,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -9376,7 +9704,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -9390,7 +9718,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -9403,7 +9731,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -9417,7 +9745,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -9431,7 +9759,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -9441,7 +9769,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -9455,7 +9783,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -9469,13 +9797,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -9485,7 +9823,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -9507,7 +9845,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -9527,7 +9865,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 262, + "line": 264, "character": 8 } ], @@ -9577,7 +9915,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -9597,7 +9935,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 112, + "line": 114, "character": 8 } ], @@ -9620,10 +9958,10 @@ "flags": {}, "type": { "type": "reference", - "id": 593, + "id": 613, "name": "GenerateLinkParams", "dereferenced": { - "id": 593, + "id": 613, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -9631,7 +9969,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 601, "character": 12 } ], @@ -9639,7 +9977,7 @@ "type": "union", "types": [ { - "id": 568, + "id": 588, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -9647,21 +9985,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 589, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 571, + "id": 591, "name": "email", "kind": 1024, "kindString": "Property", @@ -9669,7 +10007,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 534, + "line": 560, "character": 2 } ], @@ -9679,7 +10017,7 @@ } }, { - "id": 573, + "id": 593, "name": "options", "kind": 1024, "kindString": "Property", @@ -9689,7 +10027,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 536, + "line": 562, "character": 2 } ], @@ -9698,7 +10036,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -9721,7 +10059,7 @@ } }, { - "id": 572, + "id": 592, "name": "password", "kind": 1024, "kindString": "Property", @@ -9729,7 +10067,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 535, + "line": 561, "character": 2 } ], @@ -9739,7 +10077,7 @@ } }, { - "id": 570, + "id": 590, "name": "type", "kind": 1024, "kindString": "Property", @@ -9747,7 +10085,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 533, + "line": 559, "character": 2 } ], @@ -9761,13 +10099,18 @@ { "title": "Properties", "kind": 1024, - "children": [571, 573, 572, 570] + "children": [ + 591, + 593, + 592, + 590 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 39 } ] @@ -9775,7 +10118,7 @@ } }, { - "id": 574, + "id": 594, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -9783,21 +10126,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 597, "name": "email", "kind": 1024, "kindString": "Property", @@ -9808,7 +10151,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 542, + "line": 568, "character": 2 } ], @@ -9818,7 +10161,7 @@ } }, { - "id": 578, + "id": 598, "name": "options", "kind": 1024, "kindString": "Property", @@ -9828,7 +10171,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 543, + "line": 569, "character": 2 } ], @@ -9837,7 +10180,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -9860,7 +10203,7 @@ } }, { - "id": 576, + "id": 596, "name": "type", "kind": 1024, "kindString": "Property", @@ -9868,7 +10211,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 540, + "line": 566, "character": 2 } ], @@ -9891,13 +10234,17 @@ { "title": "Properties", "kind": 1024, - "children": [577, 578, 576] + "children": [ + 597, + 598, + 596 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 46 } ] @@ -9905,7 +10252,7 @@ } }, { - "id": 579, + "id": 599, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -9913,21 +10260,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 602, "name": "email", "kind": 1024, "kindString": "Property", @@ -9938,7 +10285,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 575, "character": 2 } ], @@ -9948,7 +10295,7 @@ } }, { - "id": 583, + "id": 603, "name": "options", "kind": 1024, "kindString": "Property", @@ -9958,7 +10305,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 550, + "line": 576, "character": 2 } ], @@ -9967,7 +10314,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -9981,7 +10328,7 @@ } }, { - "id": 581, + "id": 601, "name": "type", "kind": 1024, "kindString": "Property", @@ -9989,7 +10336,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 547, + "line": 573, "character": 2 } ], @@ -10003,13 +10350,17 @@ { "title": "Properties", "kind": 1024, - "children": [582, 583, 581] + "children": [ + 602, + 603, + 601 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 41 } ] @@ -10017,7 +10368,7 @@ } }, { - "id": 584, + "id": 604, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -10025,21 +10376,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 607, "name": "email", "kind": 1024, "kindString": "Property", @@ -10050,7 +10401,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 556, + "line": 582, "character": 2 } ], @@ -10060,7 +10411,7 @@ } }, { - "id": 588, + "id": 608, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -10071,7 +10422,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 560, + "line": 586, "character": 2 } ], @@ -10081,7 +10432,7 @@ } }, { - "id": 589, + "id": 609, "name": "options", "kind": 1024, "kindString": "Property", @@ -10091,7 +10442,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 587, "character": 2 } ], @@ -10100,7 +10451,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -10114,7 +10465,7 @@ } }, { - "id": 586, + "id": 606, "name": "type", "kind": 1024, "kindString": "Property", @@ -10122,7 +10473,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 554, + "line": 580, "character": 2 } ], @@ -10145,13 +10496,18 @@ { "title": "Properties", "kind": 1024, - "children": [587, 588, 589, 586] + "children": [ + 607, + 608, + 609, + 606 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 44 } ] @@ -10169,7 +10525,7 @@ "typeArguments": [ { "type": "reference", - "id": 594, + "id": 614, "name": "GenerateLinkResponse" } ], @@ -10189,7 +10545,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 215, + "line": 217, "character": 8 } ], @@ -10224,7 +10580,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -10244,7 +10600,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 82, + "line": 81, "character": 8 } ], @@ -10279,6 +10635,9 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Additional options to be included when inviting.\n" + }, "type": { "type": "reflection", "declaration": { @@ -10289,7 +10648,7 @@ "flags": {}, "children": [ { - "id": 39, + "id": 38, "name": "data", "kind": 1024, "kindString": "Property", @@ -10297,12 +10656,12 @@ "isOptional": true }, "comment": { - "shortText": "Optional user metadata\n" + "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": 86, + "line": 85, "character": 6 } ], @@ -10312,7 +10671,7 @@ } }, { - "id": 38, + "id": 39, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -10320,12 +10679,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." + "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": 85, + "line": 88, "character": 6 } ], @@ -10339,7 +10698,10 @@ { "title": "Properties", "kind": 1024, - "children": [39, 38] + "children": [ + 38, + 39 + ] } ] } @@ -10352,7 +10714,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -10372,7 +10734,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 168, + "line": 170, "character": 8 } ], @@ -10401,10 +10763,10 @@ }, "type": { "type": "reference", - "id": 774, + "id": 794, "name": "PageParams", "dereferenced": { - "id": 774, + "id": 794, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -10412,21 +10774,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 775, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 796, "name": "page", "kind": 1024, "kindString": "Property", @@ -10439,7 +10801,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 952, + "line": 978, "character": 2 } ], @@ -10449,7 +10811,7 @@ } }, { - "id": 777, + "id": 797, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -10462,7 +10824,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 954, + "line": 980, "character": 2 } ], @@ -10476,13 +10838,16 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777] + "children": [ + 796, + 797 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 25 } ] @@ -10516,7 +10881,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 8 } ], @@ -10541,7 +10906,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 31 } ], @@ -10559,7 +10924,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 16 } ], @@ -10567,7 +10932,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 420, + "id": 425, "name": "User" } } @@ -10577,14 +10942,17 @@ { "title": "Properties", "kind": 1024, - "children": [53, 52] + "children": [ + 53, + 52 + ] } ] } }, { "type": "reference", - "id": 767, + "id": 787, "name": "Pagination" } ] @@ -10599,7 +10967,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 59 } ], @@ -10613,7 +10981,10 @@ { "title": "Properties", "kind": 1024, - "children": [50, 54] + "children": [ + 50, + 54 + ] } ] } @@ -10636,7 +11007,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 8 } ], @@ -10658,7 +11029,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 16 } ], @@ -10671,7 +11042,9 @@ { "title": "Properties", "kind": 1024, - "children": [58] + "children": [ + 58 + ] } ] } @@ -10686,13 +11059,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 29 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -10701,7 +11074,10 @@ { "title": "Properties", "kind": 1024, - "children": [56, 59] + "children": [ + 56, + 59 + ] } ] } @@ -10807,7 +11183,7 @@ }, { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] @@ -10818,7 +11194,10 @@ { "title": "Properties", "kind": 1024, - "children": [31, 32] + "children": [ + 31, + 32 + ] } ] } @@ -10840,7 +11219,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 237, + "line": 239, "character": 8 } ], @@ -10877,17 +11256,17 @@ }, "type": { "type": "reference", - "id": 448, + "id": 454, "name": "AdminUserAttributes", "dereferenced": { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -10901,7 +11280,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -10911,7 +11290,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -10925,7 +11304,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -10935,7 +11314,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -10948,7 +11327,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -10962,7 +11341,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -10976,7 +11355,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -10986,7 +11365,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -10999,7 +11406,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -11013,7 +11420,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -11026,7 +11433,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -11040,7 +11447,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -11054,7 +11461,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -11064,7 +11471,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -11078,7 +11485,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -11092,13 +11499,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -11108,7 +11525,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -11130,7 +11547,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -11146,17 +11563,30 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [ + 2 + ] }, { "title": "Properties", "kind": 1024, - "children": [16] + "children": [ + 16 + ] }, { "title": "Methods", "kind": 2048, - "children": [43, 67, 40, 60, 33, 46, 27, 63] + "children": [ + 43, + 67, + 40, + 60, + 33, + 46, + 27, + 63 + ] } ], "sources": [ @@ -11183,7 +11613,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 144, + "line": 145, "character": 2 } ], @@ -11206,10 +11636,10 @@ "flags": {}, "type": { "type": "reference", - "id": 323, + "id": 328, "name": "GoTrueClientOptions", "dereferenced": { - "id": 323, + "id": 328, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -11217,21 +11647,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 35, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 332, + "id": 337, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -11241,7 +11671,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 44, + "line": 45, "character": 2 } ], @@ -11251,7 +11681,7 @@ } }, { - "id": 331, + "id": 336, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -11261,7 +11691,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 42, + "line": 43, "character": 2 } ], @@ -11271,7 +11701,7 @@ } }, { - "id": 335, + "id": 340, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -11281,7 +11711,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 50, + "line": 51, "character": 2 } ], @@ -11291,7 +11721,7 @@ } }, { - "id": 336, + "id": 341, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -11301,16 +11731,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 52, + "line": 53, "character": 2 } ], "type": { "type": "reference", - "id": 515, + "id": 522, "name": "AuthFlowType", "dereferenced": { - "id": 515, + "id": 522, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -11318,7 +11748,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 439, + "line": 447, "character": 12 } ], @@ -11339,7 +11769,7 @@ } }, { - "id": 326, + "id": 331, "name": "headers", "kind": 1024, "kindString": "Property", @@ -11349,14 +11779,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 327, + "id": 332, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -11364,19 +11794,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 12 } ], "indexSignature": { - "id": 328, + "id": 333, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 329, + "id": 334, "name": "key", "kind": 32768, "flags": {}, @@ -11395,7 +11825,7 @@ } }, { - "id": 333, + "id": 338, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -11405,7 +11835,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 47, "character": 2 } ], @@ -11415,7 +11845,7 @@ } }, { - "id": 334, + "id": 339, "name": "storage", "kind": 1024, "kindString": "Property", @@ -11425,16 +11855,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 49, "character": 2 } ], "type": { "type": "reference", - "id": 756, + "id": 776, "name": "SupportedStorage", "dereferenced": { - "id": 756, + "id": 776, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -11442,7 +11872,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 929, + "line": 955, "character": 12 } ], @@ -11487,7 +11917,7 @@ } }, { - "id": 330, + "id": 335, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -11497,7 +11927,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 40, + "line": 41, "character": 2 } ], @@ -11507,7 +11937,7 @@ } }, { - "id": 325, + "id": 330, "name": "url", "kind": 1024, "kindString": "Property", @@ -11517,7 +11947,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 36, + "line": 37, "character": 2 } ], @@ -11531,13 +11961,23 @@ { "title": "Properties", "kind": 1024, - "children": [332, 331, 335, 336, 326, 333, 334, 330, 325] + "children": [ + 337, + 336, + 340, + 341, + 331, + 338, + 339, + 335, + 330 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 35, "character": 34 } ] @@ -11567,7 +12007,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 97, + "line": 98, "character": 2 } ], @@ -11780,7 +12220,11 @@ { "title": "Properties", "kind": 1024, - "children": [11, 7, 6] + "children": [ + 11, + 7, + 6 + ] } ] } @@ -11813,10 +12257,10 @@ ], "type": { "type": "reference", - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -11832,14 +12276,14 @@ }, "children": [ { - "id": 753, + "id": 773, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 754, + "id": 774, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -11859,17 +12303,17 @@ }, "parameters": [ { - "id": 755, + "id": 775, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -11885,21 +12329,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "id", "kind": 1024, "kindString": "Property", @@ -11910,7 +12354,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 870, + "line": 896, "character": 2 } ], @@ -11920,7 +12364,7 @@ } }, { - "id": 736, + "id": 756, "name": "userId", "kind": 1024, "kindString": "Property", @@ -11931,7 +12375,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 873, + "line": 899, "character": 2 } ], @@ -11945,13 +12389,16 @@ { "title": "Properties", "kind": 1024, - "children": [735, 736] + "children": [ + 755, + 756 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 45 } ] @@ -11966,7 +12413,7 @@ "typeArguments": [ { "type": "reference", - "id": 724, + "id": 744, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -11978,14 +12425,14 @@ ] }, { - "id": 750, + "id": 770, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 751, + "id": 771, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -11995,17 +12442,17 @@ }, "parameters": [ { - "id": 752, + "id": 772, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -12021,21 +12468,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 747, + "id": 767, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 768, "name": "userId", "kind": 1024, "kindString": "Property", @@ -12046,7 +12493,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 920, "character": 2 } ], @@ -12060,13 +12507,15 @@ { "title": "Properties", "kind": 1024, - "children": [748] + "children": [ + 768 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 44 } ] @@ -12081,7 +12530,7 @@ "typeArguments": [ { "type": "reference", - "id": 737, + "id": 757, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -12097,13 +12546,16 @@ { "title": "Methods", "kind": 2048, - "children": [753, 750] + "children": [ + 773, + 770 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 902, + "line": 928, "character": 17 } ] @@ -12119,7 +12571,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 146, + "line": 148, "character": 8 } ], @@ -12142,17 +12594,17 @@ "flags": {}, "type": { "type": "reference", - "id": 448, + "id": 454, "name": "AdminUserAttributes", "dereferenced": { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -12166,7 +12618,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -12176,7 +12628,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -12190,7 +12642,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -12200,7 +12652,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -12213,7 +12665,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -12227,7 +12679,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -12241,7 +12693,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -12251,7 +12703,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -12264,7 +12744,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -12278,7 +12758,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12291,7 +12771,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -12305,7 +12785,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -12319,7 +12799,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -12329,7 +12809,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -12343,7 +12823,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -12357,13 +12837,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -12373,7 +12863,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -12395,7 +12885,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -12415,7 +12905,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 262, + "line": 264, "character": 8 } ], @@ -12465,7 +12955,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -12485,7 +12975,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 112, + "line": 114, "character": 8 } ], @@ -12508,10 +12998,10 @@ "flags": {}, "type": { "type": "reference", - "id": 593, + "id": 613, "name": "GenerateLinkParams", "dereferenced": { - "id": 593, + "id": 613, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -12519,7 +13009,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 601, "character": 12 } ], @@ -12527,7 +13017,7 @@ "type": "union", "types": [ { - "id": 568, + "id": 588, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -12535,21 +13025,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 589, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 571, + "id": 591, "name": "email", "kind": 1024, "kindString": "Property", @@ -12557,7 +13047,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 534, + "line": 560, "character": 2 } ], @@ -12567,7 +13057,7 @@ } }, { - "id": 573, + "id": 593, "name": "options", "kind": 1024, "kindString": "Property", @@ -12577,7 +13067,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 536, + "line": 562, "character": 2 } ], @@ -12586,7 +13076,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -12609,7 +13099,7 @@ } }, { - "id": 572, + "id": 592, "name": "password", "kind": 1024, "kindString": "Property", @@ -12617,7 +13107,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 535, + "line": 561, "character": 2 } ], @@ -12627,7 +13117,7 @@ } }, { - "id": 570, + "id": 590, "name": "type", "kind": 1024, "kindString": "Property", @@ -12635,7 +13125,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 533, + "line": 559, "character": 2 } ], @@ -12649,13 +13139,18 @@ { "title": "Properties", "kind": 1024, - "children": [571, 573, 572, 570] + "children": [ + 591, + 593, + 592, + 590 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 39 } ] @@ -12663,7 +13158,7 @@ } }, { - "id": 574, + "id": 594, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -12671,21 +13166,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 597, "name": "email", "kind": 1024, "kindString": "Property", @@ -12696,7 +13191,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 542, + "line": 568, "character": 2 } ], @@ -12706,7 +13201,7 @@ } }, { - "id": 578, + "id": 598, "name": "options", "kind": 1024, "kindString": "Property", @@ -12716,7 +13211,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 543, + "line": 569, "character": 2 } ], @@ -12725,7 +13220,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -12748,7 +13243,7 @@ } }, { - "id": 576, + "id": 596, "name": "type", "kind": 1024, "kindString": "Property", @@ -12756,7 +13251,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 540, + "line": 566, "character": 2 } ], @@ -12779,13 +13274,17 @@ { "title": "Properties", "kind": 1024, - "children": [577, 578, 576] + "children": [ + 597, + 598, + 596 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 46 } ] @@ -12793,7 +13292,7 @@ } }, { - "id": 579, + "id": 599, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -12801,21 +13300,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 602, "name": "email", "kind": 1024, "kindString": "Property", @@ -12826,7 +13325,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 575, "character": 2 } ], @@ -12836,7 +13335,7 @@ } }, { - "id": 583, + "id": 603, "name": "options", "kind": 1024, "kindString": "Property", @@ -12846,7 +13345,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 550, + "line": 576, "character": 2 } ], @@ -12855,7 +13354,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -12869,7 +13368,7 @@ } }, { - "id": 581, + "id": 601, "name": "type", "kind": 1024, "kindString": "Property", @@ -12877,7 +13376,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 547, + "line": 573, "character": 2 } ], @@ -12891,13 +13390,17 @@ { "title": "Properties", "kind": 1024, - "children": [582, 583, 581] + "children": [ + 602, + 603, + 601 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 41 } ] @@ -12905,7 +13408,7 @@ } }, { - "id": 584, + "id": 604, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -12913,21 +13416,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 607, "name": "email", "kind": 1024, "kindString": "Property", @@ -12938,7 +13441,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 556, + "line": 582, "character": 2 } ], @@ -12948,7 +13451,7 @@ } }, { - "id": 588, + "id": 608, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -12959,7 +13462,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 560, + "line": 586, "character": 2 } ], @@ -12969,7 +13472,7 @@ } }, { - "id": 589, + "id": 609, "name": "options", "kind": 1024, "kindString": "Property", @@ -12979,7 +13482,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 587, "character": 2 } ], @@ -12988,7 +13491,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -13002,7 +13505,7 @@ } }, { - "id": 586, + "id": 606, "name": "type", "kind": 1024, "kindString": "Property", @@ -13010,7 +13513,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 554, + "line": 580, "character": 2 } ], @@ -13033,13 +13536,18 @@ { "title": "Properties", "kind": 1024, - "children": [587, 588, 589, 586] + "children": [ + 607, + 608, + 609, + 606 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 44 } ] @@ -13057,7 +13565,7 @@ "typeArguments": [ { "type": "reference", - "id": 594, + "id": 614, "name": "GenerateLinkResponse" } ], @@ -13077,7 +13585,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 215, + "line": 217, "character": 8 } ], @@ -13112,7 +13620,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -13132,7 +13640,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 82, + "line": 81, "character": 8 } ], @@ -13167,6 +13675,9 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Additional options to be included when inviting.\n" + }, "type": { "type": "reflection", "declaration": { @@ -13177,7 +13688,7 @@ "flags": {}, "children": [ { - "id": 39, + "id": 38, "name": "data", "kind": 1024, "kindString": "Property", @@ -13185,12 +13696,12 @@ "isOptional": true }, "comment": { - "shortText": "Optional user metadata\n" + "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": 86, + "line": 85, "character": 6 } ], @@ -13200,7 +13711,7 @@ } }, { - "id": 38, + "id": 39, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -13208,12 +13719,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." + "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": 85, + "line": 88, "character": 6 } ], @@ -13227,7 +13738,10 @@ { "title": "Properties", "kind": 1024, - "children": [39, 38] + "children": [ + 38, + 39 + ] } ] } @@ -13240,7 +13754,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -13260,7 +13774,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 168, + "line": 170, "character": 8 } ], @@ -13289,10 +13803,10 @@ }, "type": { "type": "reference", - "id": 774, + "id": 794, "name": "PageParams", "dereferenced": { - "id": 774, + "id": 794, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -13300,21 +13814,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 775, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 796, "name": "page", "kind": 1024, "kindString": "Property", @@ -13327,7 +13841,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 952, + "line": 978, "character": 2 } ], @@ -13337,7 +13851,7 @@ } }, { - "id": 777, + "id": 797, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -13350,7 +13864,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 954, + "line": 980, "character": 2 } ], @@ -13364,13 +13878,16 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777] + "children": [ + 796, + 797 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 25 } ] @@ -13404,7 +13921,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 8 } ], @@ -13429,7 +13946,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 31 } ], @@ -13447,7 +13964,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 16 } ], @@ -13455,7 +13972,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 420, + "id": 425, "name": "User" } } @@ -13465,14 +13982,17 @@ { "title": "Properties", "kind": 1024, - "children": [53, 52] + "children": [ + 53, + 52 + ] } ] } }, { "type": "reference", - "id": 767, + "id": 787, "name": "Pagination" } ] @@ -13487,7 +14007,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 59 } ], @@ -13501,7 +14021,10 @@ { "title": "Properties", "kind": 1024, - "children": [50, 54] + "children": [ + 50, + 54 + ] } ] } @@ -13524,7 +14047,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 8 } ], @@ -13546,7 +14069,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 16 } ], @@ -13559,7 +14082,9 @@ { "title": "Properties", "kind": 1024, - "children": [58] + "children": [ + 58 + ] } ] } @@ -13574,13 +14099,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 29 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -13589,7 +14114,10 @@ { "title": "Properties", "kind": 1024, - "children": [56, 59] + "children": [ + 56, + 59 + ] } ] } @@ -13695,7 +14223,7 @@ }, { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] @@ -13706,7 +14234,10 @@ { "title": "Properties", "kind": 1024, - "children": [31, 32] + "children": [ + 31, + 32 + ] } ] } @@ -13728,7 +14259,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 237, + "line": 239, "character": 8 } ], @@ -13765,17 +14296,17 @@ }, "type": { "type": "reference", - "id": 448, + "id": 454, "name": "AdminUserAttributes", "dereferenced": { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -13789,7 +14320,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -13799,7 +14330,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -13813,7 +14344,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -13823,7 +14354,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -13836,7 +14367,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -13850,7 +14381,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -13864,7 +14395,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -13874,7 +14405,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -13887,7 +14446,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -13901,7 +14460,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -13914,7 +14473,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -13928,7 +14487,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -13942,7 +14501,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -13952,7 +14511,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -13966,7 +14525,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -13980,13 +14539,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -13996,7 +14565,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -14018,7 +14587,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -14034,17 +14603,30 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [ + 2 + ] }, { "title": "Properties", "kind": 1024, - "children": [16] + "children": [ + 16 + ] }, { "title": "Methods", "kind": 2048, - "children": [43, 67, 40, 60, 33, 46, 27, 63] + "children": [ + 43, + 67, + 40, + 60, + 33, + 46, + 27, + 63 + ] } ], "sources": [ @@ -14069,16 +14651,16 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 101, + "line": 102, "character": 2 } ], "type": { "type": "reference", - "id": 704, + "id": 724, "name": "GoTrueMFAApi", "dereferenced": { - "id": 704, + "id": 724, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -14088,14 +14670,14 @@ }, "children": [ { - "id": 708, + "id": 728, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 709, + "id": 729, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -14105,17 +14687,17 @@ }, "parameters": [ { - "id": 710, + "id": 730, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 628, + "id": 648, "name": "MFAChallengeParams", "dereferenced": { - "id": 628, + "id": 648, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -14123,21 +14705,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 630, + "id": 650, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -14148,7 +14730,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 680, "character": 2 } ], @@ -14162,13 +14744,15 @@ { "title": "Properties", "kind": 1024, - "children": [630] + "children": [ + 650 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 33 } ] @@ -14183,7 +14767,7 @@ "typeArguments": [ { "type": "reference", - "id": 672, + "id": 692, "name": "AuthMFAChallengeResponse" } ], @@ -14195,14 +14779,14 @@ ] }, { - "id": 717, + "id": 737, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 718, + "id": 738, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -14212,17 +14796,17 @@ }, "parameters": [ { - "id": 719, + "id": 739, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -14230,21 +14814,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 634, + "id": 654, "name": "code", "kind": 1024, "kindString": "Property", @@ -14255,7 +14839,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 661, + "line": 687, "character": 2 } ], @@ -14265,7 +14849,7 @@ } }, { - "id": 633, + "id": 653, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -14276,7 +14860,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 685, "character": 2 } ], @@ -14290,13 +14874,16 @@ { "title": "Properties", "kind": 1024, - "children": [634, 633] + "children": [ + 654, + 653 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 42 } ] @@ -14311,7 +14898,7 @@ "typeArguments": [ { "type": "reference", - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse" } ], @@ -14323,14 +14910,14 @@ ] }, { - "id": 705, + "id": 725, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 706, + "id": 726, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -14341,17 +14928,17 @@ }, "parameters": [ { - "id": 707, + "id": 727, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 635, "name": "MFAEnrollParams", "dereferenced": { - "id": 615, + "id": 635, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -14359,21 +14946,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 636, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 637, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -14384,7 +14971,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 629, + "line": 655, "character": 2 } ], @@ -14394,7 +14981,7 @@ } }, { - "id": 619, + "id": 639, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -14407,7 +14994,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 633, + "line": 659, "character": 2 } ], @@ -14417,7 +15004,7 @@ } }, { - "id": 618, + "id": 638, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -14430,7 +15017,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 631, + "line": 657, "character": 2 } ], @@ -14444,13 +15031,17 @@ { "title": "Properties", "kind": 1024, - "children": [617, 619, 618] + "children": [ + 637, + 639, + 638 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 30 } ] @@ -14465,7 +15056,7 @@ "typeArguments": [ { "type": "reference", - "id": 648, + "id": 668, "name": "AuthMFAEnrollResponse" } ], @@ -14477,14 +15068,14 @@ ] }, { - "id": 722, + "id": 742, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 723, + "id": 743, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -14498,7 +15089,7 @@ "typeArguments": [ { "type": "reference", - "id": 693, + "id": 713, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -14510,14 +15101,14 @@ ] }, { - "id": 720, + "id": 740, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 721, + "id": 741, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -14544,7 +15135,7 @@ "typeArguments": [ { "type": "reference", - "id": 682, + "id": 702, "name": "AuthMFAListFactorsResponse" } ], @@ -14556,14 +15147,14 @@ ] }, { - "id": 714, + "id": 734, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 715, + "id": 735, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -14573,17 +15164,17 @@ }, "parameters": [ { - "id": 716, + "id": 736, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "dereferenced": { - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -14591,21 +15182,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 621, + "id": 641, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 642, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -14616,7 +15207,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 638, + "line": 664, "character": 2 } ], @@ -14630,13 +15221,15 @@ { "title": "Properties", "kind": 1024, - "children": [622] + "children": [ + 642 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 32 } ] @@ -14651,7 +15244,7 @@ "typeArguments": [ { "type": "reference", - "id": 663, + "id": 683, "name": "AuthMFAUnenrollResponse" } ], @@ -14663,14 +15256,14 @@ ] }, { - "id": 711, + "id": 731, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 712, + "id": 732, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -14680,17 +15273,17 @@ }, "parameters": [ { - "id": 713, + "id": 733, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 623, + "id": 643, "name": "MFAVerifyParams", "dereferenced": { - "id": 623, + "id": 643, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -14698,21 +15291,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 644, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 646, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -14723,7 +15316,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 672, "character": 2 } ], @@ -14733,7 +15326,7 @@ } }, { - "id": 627, + "id": 647, "name": "code", "kind": 1024, "kindString": "Property", @@ -14744,7 +15337,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 675, "character": 2 } ], @@ -14754,7 +15347,7 @@ } }, { - "id": 625, + "id": 645, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -14765,7 +15358,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 669, "character": 2 } ], @@ -14779,13 +15372,17 @@ { "title": "Properties", "kind": 1024, - "children": [626, 627, 625] + "children": [ + 646, + 647, + 645 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 30 } ] @@ -14800,7 +15397,7 @@ "typeArguments": [ { "type": "reference", - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse" } ], @@ -14816,13 +15413,21 @@ { "title": "Methods", "kind": 2048, - "children": [708, 717, 705, 722, 720, 714, 711] + "children": [ + 728, + 737, + 725, + 742, + 740, + 734, + 731 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 789, + "line": 815, "character": 17 } ] @@ -14838,7 +15443,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 410, + "line": 411, "character": 8 } ], @@ -14850,7 +15455,7 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user via a third-party provider." + "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." }, "parameters": [ { @@ -14870,7 +15475,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -14882,7 +15487,7 @@ ] }, { - "id": 136, + "id": 141, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -14890,13 +15495,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 625, + "line": 693, "character": 8 } ], "signatures": [ { - "id": 137, + "id": 142, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -14910,95 +15515,6 @@ { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 139, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 627, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 628, - "character": 10 - } - ], - "type": { - "type": "reference", - "id": 383, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 630, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [139, 142] - } - ] - } - }, { "type": "reflection", "declaration": { @@ -15017,7 +15533,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 633, + "line": 695, "character": 8 } ], @@ -15039,13 +15555,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 634, + "line": 696, "character": 10 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 388, + "name": "Session" } } ], @@ -15053,7 +15570,9 @@ { "title": "Properties", "kind": 1024, - "children": [146] + "children": [ + 146 + ] } ] } @@ -15068,14 +15587,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 636, + "line": 698, "character": 8 } ], "type": { - "type": "reference", - "id": 784, - "name": "AuthError" + "type": "literal", + "value": null } } ], @@ -15083,7 +15601,10 @@ { "title": "Properties", "kind": 1024, - "children": [144, 147] + "children": [ + 144, + 147 + ] } ] } @@ -15106,7 +15627,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 639, + "line": 701, "character": 8 } ], @@ -15128,7 +15649,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 640, + "line": 702, "character": 10 } ], @@ -15142,7 +15663,9 @@ { "title": "Properties", "kind": 1024, - "children": [151] + "children": [ + 151 + ] } ] } @@ -15157,7 +15680,101 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 642, + "line": 704, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 149, + 152 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 153, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 154, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 707, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 156, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 708, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 156 + ] + } + ] + } + } + }, + { + "id": 157, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 710, "character": 8 } ], @@ -15171,7 +15788,10 @@ { "title": "Properties", "kind": 1024, - "children": [149, 152] + "children": [ + 154, + 157 + ] } ] } @@ -15187,7 +15807,7 @@ ] }, { - "id": 153, + "id": 158, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -15195,13 +15815,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 688, + "line": 756, "character": 8 } ], "signatures": [ { - "id": 154, + "id": 159, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -15211,7 +15831,7 @@ }, "parameters": [ { - "id": 155, + "id": 160, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -15232,7 +15852,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -15252,7 +15872,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 196, + "line": 197, "character": 2 } ], @@ -15271,7 +15891,7 @@ "typeArguments": [ { "type": "reference", - "id": 757, + "id": 777, "name": "InitializeResult" } ], @@ -15283,7 +15903,7 @@ ] }, { - "id": 203, + "id": 208, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -15291,13 +15911,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1000, + "line": 1071, "character": 2 } ], "signatures": [ { - "id": 204, + "id": 209, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -15307,7 +15927,7 @@ }, "parameters": [ { - "id": 205, + "id": 210, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -15318,33 +15938,33 @@ "type": { "type": "reflection", "declaration": { - "id": 206, + "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 207, + "id": 212, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 208, + "id": 213, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 322, + "id": 327, "name": "AuthChangeEvent" } }, { - "id": 209, + "id": 214, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -15358,7 +15978,7 @@ }, { "type": "reference", - "id": 383, + "id": 388, "name": "Session" } ] @@ -15378,14 +15998,14 @@ "type": { "type": "reflection", "declaration": { - "id": 210, + "id": 215, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 211, + "id": 216, "name": "data", "kind": 1024, "kindString": "Property", @@ -15393,21 +16013,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1001, + "line": 1072, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 212, + "id": 217, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 213, + "id": 218, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -15415,23 +16035,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1001, + "line": 1072, "character": 12 } ], "type": { "type": "reference", - "id": 457, + "id": 464, "name": "Subscription", "dereferenced": { - "id": 457, + "id": 464, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 458, + "id": 465, "name": "id", "kind": 1024, "kindString": "Property", @@ -15442,7 +16062,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 329, "character": 2 } ], @@ -15452,7 +16072,7 @@ } }, { - "id": 459, + "id": 466, "name": "callback", "kind": 2048, "kindString": "Method", @@ -15460,13 +16080,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 325, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 460, + "id": 467, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -15476,17 +16096,17 @@ }, "parameters": [ { - "id": 461, + "id": 468, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 322, + "id": 327, "name": "AuthChangeEvent", "dereferenced": { - "id": 322, + "id": 327, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -15494,7 +16114,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 25, + "line": 26, "character": 12 } ], @@ -15526,7 +16146,7 @@ "value": "USER_UPDATED" }, { - "id": 321, + "id": 326, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -15534,7 +16154,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, + "line": 24, "character": 12 } ], @@ -15549,7 +16169,7 @@ } }, { - "id": 462, + "id": 469, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -15563,7 +16183,7 @@ }, { "type": "reference", - "id": 383, + "id": 388, "name": "Session" } ] @@ -15578,7 +16198,7 @@ ] }, { - "id": 463, + "id": 470, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -15586,13 +16206,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 329, + "line": 337, "character": 2 } ], "signatures": [ { - "id": 464, + "id": 471, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -15612,18 +16232,23 @@ { "title": "Properties", "kind": 1024, - "children": [458] + "children": [ + 465 + ] }, { "title": "Methods", "kind": 2048, - "children": [459, 463] + "children": [ + 466, + 470 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 317, + "line": 325, "character": 17 } ] @@ -15635,7 +16260,9 @@ { "title": "Properties", "kind": 1024, - "children": [213] + "children": [ + 218 + ] } ] } @@ -15646,7 +16273,9 @@ { "title": "Properties", "kind": 1024, - "children": [211] + "children": [ + 216 + ] } ] } @@ -15655,7 +16284,46 @@ ] }, { - "id": 175, + "id": 136, + "name": "reauthenticate", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 626, + "character": 8 + } + ], + "signatures": [ + { + "id": 137, + "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": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 180, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -15663,13 +16331,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 834, + "line": 902, "character": 8 } ], "signatures": [ { - "id": 176, + "id": 181, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -15679,7 +16347,7 @@ }, "parameters": [ { - "id": 177, + "id": 182, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -15692,14 +16360,14 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 179, + "id": 184, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -15707,7 +16375,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 834, + "line": 902, "character": 42 } ], @@ -15721,7 +16389,9 @@ { "title": "Properties", "kind": 1024, - "children": [179] + "children": [ + 184 + ] } ] } @@ -15733,7 +16403,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -15745,7 +16415,389 @@ ] }, { - "id": 217, + "id": 138, + "name": "resend", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 651, + "character": 8 + } + ], + "signatures": [ + { + "id": 139, + "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": 140, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 562, + "name": "ResendParams", + "dereferenced": { + "id": 562, + "name": "ResendParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 516, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 563, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 565, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 519, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 566, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 567, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 568, + "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": 522, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 568 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 16 + } + ] + } + } + }, + { + "id": 564, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 518, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 561, + "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": [ + 565, + 566, + 564 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 517, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 569, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 572, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 573, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 574, + "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": 530, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 574 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 16 + } + ] + } + } + }, + { + "id": 571, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 527, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 570, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 526, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 560, + "name": "MobileOtpType" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "phone" + } + ] + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 572, + 571, + 570 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 525, + "character": 4 + } + ] + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 222, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -15753,13 +16805,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1040, + "line": 1111, "character": 8 } ], "signatures": [ { - "id": 218, + "id": 223, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -15769,7 +16821,7 @@ }, "parameters": [ { - "id": 219, + "id": 224, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -15783,7 +16835,7 @@ } }, { - "id": 220, + "id": 225, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15791,14 +16843,14 @@ "type": { "type": "reflection", "declaration": { - "id": 221, + "id": 226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 223, + "id": 228, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15811,7 +16863,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1044, + "line": 1115, "character": 6 } ], @@ -15821,7 +16873,7 @@ } }, { - "id": 222, + "id": 227, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -15834,7 +16886,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1043, + "line": 1114, "character": 6 } ], @@ -15848,7 +16900,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 228, + 227 + ] } ] } @@ -15865,14 +16920,14 @@ { "type": "reflection", "declaration": { - "id": 224, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 230, "name": "data", "kind": 1024, "kindString": "Property", @@ -15880,14 +16935,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1048, + "line": 1119, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 226, + "id": 231, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -15896,7 +16951,7 @@ } }, { - "id": 227, + "id": 232, "name": "error", "kind": 1024, "kindString": "Property", @@ -15904,7 +16959,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1049, + "line": 1120, "character": 8 } ], @@ -15918,7 +16973,10 @@ { "title": "Properties", "kind": 1024, - "children": [225, 227] + "children": [ + 230, + 232 + ] } ] } @@ -15926,14 +16984,14 @@ { "type": "reflection", "declaration": { - "id": 228, + "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 229, + "id": 234, "name": "data", "kind": 1024, "kindString": "Property", @@ -15941,7 +16999,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1051, + "line": 1122, "character": 8 } ], @@ -15951,7 +17009,7 @@ } }, { - "id": 230, + "id": 235, "name": "error", "kind": 1024, "kindString": "Property", @@ -15959,13 +17017,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1051, + "line": 1122, "character": 20 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -15974,7 +17032,10 @@ { "title": "Properties", "kind": 1024, - "children": [229, 230] + "children": [ + 234, + 235 + ] } ] } @@ -15990,7 +17051,7 @@ ] }, { - "id": 169, + "id": 174, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -15998,13 +17059,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 770, + "line": 838, "character": 8 } ], "signatures": [ { - "id": 170, + "id": 175, "name": "setSession", "kind": 4096, "kindString": "Call signature", @@ -16014,7 +17075,7 @@ }, "parameters": [ { - "id": 171, + "id": 176, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -16025,14 +17086,14 @@ "type": { "type": "reflection", "declaration": { - "id": 172, + "id": 177, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 173, + "id": 178, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -16040,7 +17101,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 771, + "line": 839, "character": 4 } ], @@ -16050,7 +17111,7 @@ } }, { - "id": 174, + "id": 179, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -16058,7 +17119,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 772, + "line": 840, "character": 4 } ], @@ -16072,7 +17133,10 @@ { "title": "Properties", "kind": 1024, - "children": [173, 174] + "children": [ + 178, + 179 + ] } ] } @@ -16084,7 +17148,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -16104,7 +17168,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 440, + "line": 441, "character": 8 } ], @@ -16133,10 +17197,10 @@ "flags": {}, "type": { "type": "reference", - "id": 528, + "id": 535, "name": "SignInWithIdTokenCredentials", "dereferenced": { - "id": 528, + "id": 535, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16144,21 +17208,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 463, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 529, + "id": 536, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 532, + "id": 539, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -16171,7 +17235,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 463, + "line": 471, "character": 2 } ], @@ -16181,7 +17245,7 @@ } }, { - "id": 533, + "id": 540, "name": "options", "kind": 1024, "kindString": "Property", @@ -16191,21 +17255,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 472, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 534, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 535, + "id": 542, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16218,7 +17282,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 466, + "line": 474, "character": 4 } ], @@ -16232,13 +17296,15 @@ { "title": "Properties", "kind": 1024, - "children": [535] + "children": [ + 542 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 472, "character": 12 } ] @@ -16246,7 +17312,7 @@ } }, { - "id": 530, + "id": 537, "name": "provider", "kind": 1024, "kindString": "Property", @@ -16257,7 +17323,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 459, + "line": 467, "character": 2 } ], @@ -16276,7 +17342,7 @@ } }, { - "id": 531, + "id": 538, "name": "token", "kind": 1024, "kindString": "Property", @@ -16287,7 +17353,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 461, + "line": 469, "character": 2 } ], @@ -16301,13 +17367,18 @@ { "title": "Properties", "kind": 1024, - "children": [532, 533, 530, 531] + "children": [ + 539, + 540, + 537, + 538 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 463, "character": 43 } ] @@ -16322,7 +17393,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -16342,7 +17413,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 396, + "line": 397, "character": 8 } ], @@ -16365,10 +17436,10 @@ "flags": {}, "type": { "type": "reference", - "id": 516, + "id": 523, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 516, + "id": 523, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16376,21 +17447,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 448, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 517, + "id": 524, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 526, "name": "options", "kind": 1024, "kindString": "Property", @@ -16400,21 +17471,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 443, + "line": 451, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 520, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 523, + "id": 530, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -16427,14 +17498,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 449, + "line": 457, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 524, + "id": 531, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -16442,19 +17513,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 449, + "line": 457, "character": 18 } ], "indexSignature": { - "id": 525, + "id": 532, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 526, + "id": 533, "name": "key", "kind": 32768, "flags": {}, @@ -16473,7 +17544,7 @@ } }, { - "id": 521, + "id": 528, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -16486,7 +17557,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 445, + "line": 453, "character": 4 } ], @@ -16496,7 +17567,7 @@ } }, { - "id": 522, + "id": 529, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -16509,7 +17580,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 447, + "line": 455, "character": 4 } ], @@ -16519,7 +17590,7 @@ } }, { - "id": 527, + "id": 534, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -16532,7 +17603,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 451, + "line": 459, "character": 4 } ], @@ -16546,13 +17617,18 @@ { "title": "Properties", "kind": 1024, - "children": [523, 521, 522, 527] + "children": [ + 530, + 528, + 529, + 534 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 443, + "line": 451, "character": 12 } ] @@ -16560,7 +17636,7 @@ } }, { - "id": 518, + "id": 525, "name": "provider", "kind": 1024, "kindString": "Property", @@ -16571,16 +17647,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 442, + "line": 450, "character": 2 } ], "type": { "type": "reference", - "id": 320, + "id": 325, "name": "Provider", "dereferenced": { - "id": 320, + "id": 325, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -16661,6 +17737,10 @@ { "type": "literal", "value": "workos" + }, + { + "type": "literal", + "value": "zoom" } ] } @@ -16672,13 +17752,16 @@ { "title": "Properties", "kind": 1024, - "children": [519, 518] + "children": [ + 526, + 525 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 448, "character": 41 } ] @@ -16693,7 +17776,7 @@ "typeArguments": [ { "type": "reference", - "id": 350, + "id": 355, "name": "OAuthResponse" } ], @@ -16713,7 +17796,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 488, + "line": 489, "character": 8 } ], @@ -16737,10 +17820,10 @@ "flags": {}, "type": { "type": "reference", - "id": 498, + "id": 505, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 498, + "id": 505, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16748,7 +17831,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 401, + "line": 409, "character": 12 } ], @@ -16758,14 +17841,14 @@ { "type": "reflection", "declaration": { - "id": 499, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 500, + "id": 507, "name": "email", "kind": 1024, "kindString": "Property", @@ -16776,7 +17859,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 404, + "line": 412, "character": 6 } ], @@ -16786,7 +17869,7 @@ } }, { - "id": 501, + "id": 508, "name": "options", "kind": 1024, "kindString": "Property", @@ -16796,175 +17879,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 413, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 502, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 506, - "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": 417, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 505, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 415, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 503, - "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": 407, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 504, - "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": 409, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [506, 505, 503, 504] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 405, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [500, 501] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 402, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 507, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 509, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 423, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 510, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -16984,7 +17906,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 425, "character": 8 } ], @@ -16994,7 +17916,176 @@ } }, { - "id": 514, + "id": 512, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 423, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 510, + "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": 415, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 511, + "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": 417, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 513, + 512, + 510, + 511 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 413, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 507, + 508 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 410, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 514, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 516, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 431, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 517, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 520, + "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": 441, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 521, "name": "channel", "kind": 1024, "kindString": "Property", @@ -17007,7 +18098,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 435, + "line": 443, "character": 8 } ], @@ -17026,7 +18117,7 @@ } }, { - "id": 512, + "id": 519, "name": "data", "kind": 1024, "kindString": "Property", @@ -17040,7 +18131,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 431, + "line": 439, "character": 8 } ], @@ -17050,7 +18141,7 @@ } }, { - "id": 511, + "id": 518, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -17063,7 +18154,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 425, + "line": 433, "character": 8 } ], @@ -17077,13 +18168,18 @@ { "title": "Properties", "kind": 1024, - "children": [513, 514, 512, 511] + "children": [ + 520, + 521, + 519, + 518 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 423, + "line": 431, "character": 16 } ] @@ -17091,7 +18187,7 @@ } }, { - "id": 508, + "id": 515, "name": "phone", "kind": 1024, "kindString": "Property", @@ -17102,7 +18198,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 422, + "line": 430, "character": 6 } ], @@ -17116,13 +18212,16 @@ { "title": "Properties", "kind": 1024, - "children": [509, 508] + "children": [ + 516, + 515 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 420, + "line": 428, "character": 4 } ] @@ -17139,7 +18238,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -17159,7 +18258,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 346, + "line": 347, "character": 8 } ], @@ -17183,10 +18282,10 @@ "flags": {}, "type": { "type": "reference", - "id": 484, + "id": 491, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 484, + "id": 491, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17194,7 +18293,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 373, + "line": 381, "character": 12 } ], @@ -17204,14 +18303,14 @@ { "type": "reflection", "declaration": { - "id": 485, + "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 486, + "id": 493, "name": "email", "kind": 1024, "kindString": "Property", @@ -17222,7 +18321,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 376, + "line": 384, "character": 6 } ], @@ -17232,7 +18331,7 @@ } }, { - "id": 488, + "id": 495, "name": "options", "kind": 1024, "kindString": "Property", @@ -17242,126 +18341,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 379, + "line": 387, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 489, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 490, - "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": 381, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [490] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 379, - "character": 16 - } - ] - } - } - }, - { - "id": 487, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 378, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [486, 488, 487] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 374, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 491, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 494, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 389, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 495, + "id": 496, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -17381,7 +18368,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 397, + "line": 389, "character": 8 } ], @@ -17389,43 +18376,21 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 496, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 395, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [497, 496] + "children": [ + 497 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 389, + "line": 387, "character": 16 } ] @@ -17433,7 +18398,7 @@ } }, { - "id": 493, + "id": 494, "name": "password", "kind": 1024, "kindString": "Property", @@ -17441,27 +18406,6 @@ "comment": { "shortText": "The user's password." }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 388, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 492, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -17479,13 +18423,181 @@ { "title": "Properties", "kind": 1024, - "children": [494, 493, 492] + "children": [ + 493, + 495, + 494 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 384, + "line": 382, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 498, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 501, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 397, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 502, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 504, + "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": 405, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 503, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 403, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 504, + 503 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 397, + "character": 16 + } + ] + } + } + }, + { + "id": 500, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 396, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 499, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 394, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 501, + 500, + 499 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 392, "character": 4 } ] @@ -17502,7 +18614,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -17522,7 +18634,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 596, + "line": 597, "character": 8 } ], @@ -17546,10 +18658,10 @@ "flags": {}, "type": { "type": "reference", - "id": 555, + "id": 575, "name": "SignInWithSSO", "dereferenced": { - "id": 555, + "id": 575, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -17557,7 +18669,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 508, + "line": 534, "character": 12 } ], @@ -17567,14 +18679,14 @@ { "type": "reflection", "declaration": { - "id": 556, + "id": 576, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 558, + "id": 578, "name": "options", "kind": 1024, "kindString": "Property", @@ -17584,21 +18696,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 539, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 559, + "id": 579, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 561, + "id": 581, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17611,7 +18723,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 517, + "line": 543, "character": 8 } ], @@ -17621,7 +18733,7 @@ } }, { - "id": 560, + "id": 580, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -17634,7 +18746,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 515, + "line": 541, "character": 8 } ], @@ -17648,13 +18760,16 @@ { "title": "Properties", "kind": 1024, - "children": [561, 560] + "children": [ + 581, + 580 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 539, "character": 16 } ] @@ -17662,7 +18777,7 @@ } }, { - "id": 557, + "id": 577, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -17673,7 +18788,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 537, "character": 6 } ], @@ -17687,13 +18802,16 @@ { "title": "Properties", "kind": 1024, - "children": [558, 557] + "children": [ + 578, + 577 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 509, + "line": 535, "character": 4 } ] @@ -17702,14 +18820,14 @@ { "type": "reflection", "declaration": { - "id": 562, + "id": 582, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 563, + "id": 583, "name": "domain", "kind": 1024, "kindString": "Property", @@ -17720,7 +18838,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 522, + "line": 548, "character": 6 } ], @@ -17730,7 +18848,7 @@ } }, { - "id": 564, + "id": 584, "name": "options", "kind": 1024, "kindString": "Property", @@ -17740,21 +18858,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 524, + "line": 550, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 565, + "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 567, + "id": 587, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17767,7 +18885,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 528, + "line": 554, "character": 8 } ], @@ -17777,7 +18895,7 @@ } }, { - "id": 566, + "id": 586, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -17790,7 +18908,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 526, + "line": 552, "character": 8 } ], @@ -17804,13 +18922,16 @@ { "title": "Properties", "kind": 1024, - "children": [567, 566] + "children": [ + 587, + 586 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 524, + "line": 550, "character": 16 } ] @@ -17822,13 +18943,16 @@ { "title": "Properties", "kind": 1024, - "children": [563, 564] + "children": [ + 583, + 584 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 520, + "line": 546, "character": 4 } ] @@ -17845,7 +18969,7 @@ "typeArguments": [ { "type": "reference", - "id": 363, + "id": 368, "name": "SSOResponse" } ], @@ -17857,7 +18981,7 @@ ] }, { - "id": 199, + "id": 204, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -17865,13 +18989,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 974, + "line": 1045, "character": 8 } ], "signatures": [ { - "id": 200, + "id": 205, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -17886,14 +19010,14 @@ { "type": "reflection", "declaration": { - "id": 201, + "id": 206, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 202, + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -17901,7 +19025,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 974, + "line": 1045, "character": 29 } ], @@ -17914,7 +19038,7 @@ }, { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] @@ -17925,7 +19049,9 @@ { "title": "Properties", "kind": 1024, - "children": [202] + "children": [ + 207 + ] } ] } @@ -17947,7 +19073,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 267, + "line": 268, "character": 8 } ], @@ -17972,10 +19098,10 @@ "flags": {}, "type": { "type": "reference", - "id": 467, + "id": 474, "name": "SignUpWithPasswordCredentials", "dereferenced": { - "id": 467, + "id": 474, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17983,7 +19109,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 336, + "line": 344, "character": 12 } ], @@ -17993,14 +19119,14 @@ { "type": "reflection", "declaration": { - "id": 468, + "id": 475, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 469, + "id": 476, "name": "email", "kind": 1024, "kindString": "Property", @@ -18011,7 +19137,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 339, + "line": 347, "character": 6 } ], @@ -18021,7 +19147,7 @@ } }, { - "id": 471, + "id": 478, "name": "options", "kind": 1024, "kindString": "Property", @@ -18031,173 +19157,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 342, + "line": 350, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 472, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 475, - "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": 352, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 474, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 473, - "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": 344, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [475, 474, 473] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 16 - } - ] - } - } - }, - { - "id": 470, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [469, 471, 470] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 476, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 479, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 360, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 480, + "id": 479, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -18212,12 +19179,12 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 368, + "line": 360, "character": 8 } ], @@ -18227,7 +19194,174 @@ } }, { - "id": 483, + "id": 481, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 358, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 480, + "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": 352, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 482, + 481, + 480 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 350, + "character": 16 + } + ] + } + } + }, + { + "id": 477, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 349, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 476, + 478, + 477 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 345, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 483, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 486, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 487, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 489, + "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": 376, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 490, "name": "channel", "kind": 1024, "kindString": "Property", @@ -18240,7 +19374,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 370, + "line": 378, "character": 8 } ], @@ -18259,7 +19393,7 @@ } }, { - "id": 481, + "id": 488, "name": "data", "kind": 1024, "kindString": "Property", @@ -18273,7 +19407,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 374, "character": 8 } ], @@ -18287,13 +19421,17 @@ { "title": "Properties", "kind": 1024, - "children": [482, 483, 481] + "children": [ + 489, + 490, + 488 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 360, + "line": 368, "character": 16 } ] @@ -18301,7 +19439,7 @@ } }, { - "id": 478, + "id": 485, "name": "password", "kind": 1024, "kindString": "Property", @@ -18312,7 +19450,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 367, "character": 6 } ], @@ -18322,7 +19460,7 @@ } }, { - "id": 477, + "id": 484, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18333,7 +19471,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 357, + "line": 365, "character": 6 } ], @@ -18347,13 +19485,17 @@ { "title": "Properties", "kind": 1024, - "children": [479, 478, 477] + "children": [ + 486, + 485, + 484 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 355, + "line": 363, "character": 4 } ] @@ -18370,7 +19512,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -18382,7 +19524,7 @@ ] }, { - "id": 279, + "id": 284, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", @@ -18390,13 +19532,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1346, + "line": 1415, "character": 8 } ], "signatures": [ { - "id": 280, + "id": 285, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -18421,7 +19563,7 @@ ] }, { - "id": 281, + "id": 286, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", @@ -18429,13 +19571,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1359, + "line": 1428, "character": 8 } ], "signatures": [ { - "id": 282, + "id": 287, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -18460,7 +19602,7 @@ ] }, { - "id": 156, + "id": 161, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -18468,13 +19610,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 717, + "line": 785, "character": 8 } ], "signatures": [ { - "id": 157, + "id": 162, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -18484,24 +19626,24 @@ }, "parameters": [ { - "id": 158, + "id": 163, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes", "dereferenced": { - "id": 443, + "id": 448, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 447, + "id": 453, "name": "data", "kind": 1024, "kindString": "Property", @@ -18515,7 +19657,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 264, + "line": 272, "character": 2 } ], @@ -18525,7 +19667,7 @@ } }, { - "id": 444, + "id": 449, "name": "email", "kind": 1024, "kindString": "Property", @@ -18538,7 +19680,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -18548,7 +19690,31 @@ } }, { - "id": 446, + "id": 452, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, "name": "password", "kind": 1024, "kindString": "Property", @@ -18561,7 +19727,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -18571,7 +19737,7 @@ } }, { - "id": 445, + "id": 450, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18584,7 +19750,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -18598,13 +19764,19 @@ { "title": "Properties", "kind": 1024, - "children": [447, 444, 446, 445] + "children": [ + 453, + 449, + 452, + 451, + 450 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 242, + "line": 243, "character": 17 } ] @@ -18612,7 +19784,7 @@ } }, { - "id": 159, + "id": 164, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -18620,14 +19792,14 @@ "type": { "type": "reflection", "declaration": { - "id": 160, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 161, + "id": 166, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -18637,7 +19809,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 720, + "line": 788, "character": 6 } ], @@ -18651,7 +19823,9 @@ { "title": "Properties", "kind": 1024, - "children": [161] + "children": [ + 166 + ] } ] } @@ -18664,7 +19838,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -18684,7 +19858,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 543, + "line": 544, "character": 8 } ], @@ -18707,10 +19881,10 @@ "flags": {}, "type": { "type": "reference", - "id": 536, + "id": 543, "name": "VerifyOtpParams", "dereferenced": { - "id": 536, + "id": 543, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -18718,7 +19892,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 470, + "line": 478, "character": 12 } ], @@ -18726,14 +19900,14 @@ "type": "union", "types": [ { - "id": 537, + "id": 544, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 541, + "id": 548, "name": "options", "kind": 1024, "kindString": "Property", @@ -18743,21 +19917,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 478, + "line": 486, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 542, + "id": 549, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 551, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18776,7 +19950,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 495, "character": 4 } ], @@ -18786,7 +19960,7 @@ } }, { - "id": 543, + "id": 550, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -18799,7 +19973,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 480, + "line": 488, "character": 4 } ], @@ -18813,14 +19987,17 @@ { "title": "Properties", "kind": 1024, - "children": [544, 543] + "children": [ + 551, + 550 + ] } ] } } }, { - "id": 538, + "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18831,7 +20008,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 473, + "line": 481, "character": 2 } ], @@ -18841,7 +20018,7 @@ } }, { - "id": 539, + "id": 546, "name": "token", "kind": 1024, "kindString": "Property", @@ -18852,7 +20029,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 475, + "line": 483, "character": 2 } ], @@ -18862,7 +20039,7 @@ } }, { - "id": 540, + "id": 547, "name": "type", "kind": 1024, "kindString": "Property", @@ -18873,16 +20050,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 477, + "line": 485, "character": 2 } ], "type": { "type": "reference", - "id": 553, + "id": 560, "name": "MobileOtpType", "dereferenced": { - "id": 553, + "id": 560, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -18890,7 +20067,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 513, "character": 12 } ], @@ -18915,26 +20092,31 @@ { "title": "Properties", "kind": 1024, - "children": [541, 538, 539, 540] + "children": [ + 548, + 545, + 546, + 547 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 479, "character": 17 } ] }, { - "id": 545, + "id": 552, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 546, + "id": 553, "name": "email", "kind": 1024, "kindString": "Property", @@ -18945,7 +20127,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 492, + "line": 500, "character": 2 } ], @@ -18955,7 +20137,7 @@ } }, { - "id": 549, + "id": 556, "name": "options", "kind": 1024, "kindString": "Property", @@ -18965,21 +20147,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 497, + "line": 505, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 550, + "id": 557, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 559, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18992,7 +20174,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 501, + "line": 509, "character": 4 } ], @@ -19002,7 +20184,7 @@ } }, { - "id": 551, + "id": 558, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -19015,7 +20197,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 499, + "line": 507, "character": 4 } ], @@ -19029,14 +20211,17 @@ { "title": "Properties", "kind": 1024, - "children": [552, 551] + "children": [ + 559, + 558 + ] } ] } } }, { - "id": 547, + "id": 554, "name": "token", "kind": 1024, "kindString": "Property", @@ -19047,7 +20232,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 494, + "line": 502, "character": 2 } ], @@ -19057,7 +20242,7 @@ } }, { - "id": 548, + "id": 555, "name": "type", "kind": 1024, "kindString": "Property", @@ -19068,16 +20253,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 496, + "line": 504, "character": 2 } ], "type": { "type": "reference", - "id": 554, + "id": 561, "name": "EmailOtpType", "dereferenced": { - "id": 554, + "id": 561, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -19085,7 +20270,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 514, "character": 12 } ], @@ -19126,13 +20311,18 @@ { "title": "Properties", "kind": 1024, - "children": [546, 549, 547, 548] + "children": [ + 553, + 556, + 554, + 555 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 490, + "line": 498, "character": 17 } ] @@ -19148,7 +20338,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -19164,32 +20354,56 @@ { "title": "Constructors", "kind": 512, - "children": [78] + "children": [ + 78 + ] }, { "title": "Properties", "kind": 1024, - "children": [81, 82] + "children": [ + 81, + 82 + ] }, { "title": "Methods", "kind": 2048, "children": [ - 121, 136, 153, 108, 203, 175, 217, 169, 124, 118, 127, 115, 133, 199, 112, 279, 281, - 156, 130 + 121, + 141, + 158, + 108, + 208, + 136, + 180, + 138, + 222, + 174, + 124, + 118, + 127, + 115, + 133, + 204, + 112, + 284, + 286, + 161, + 130 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 92, + "line": 93, "character": 21 } ] }, { - "id": 392, + "id": 397, "name": "AMREntry", "kind": 256, "kindString": "Interface", @@ -19206,7 +20420,7 @@ }, "children": [ { - "id": 393, + "id": 398, "name": "method", "kind": 1024, "kindString": "Property", @@ -19217,7 +20431,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 160, + "line": 161, "character": 2 } ], @@ -19227,7 +20441,7 @@ } }, { - "id": 394, + "id": 399, "name": "timestamp", "kind": 1024, "kindString": "Property", @@ -19238,7 +20452,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 166, + "line": 167, "character": 2 } ], @@ -19252,26 +20466,29 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394] + "children": [ + 398, + 399 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 158, + "line": 159, "character": 17 } ] }, { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -19285,7 +20502,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -19295,7 +20512,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -19309,7 +20526,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -19319,7 +20536,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -19332,7 +20549,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -19346,7 +20563,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -19360,7 +20577,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -19370,7 +20587,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -19383,7 +20628,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -19397,7 +20642,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -19410,7 +20655,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -19424,7 +20669,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -19438,7 +20683,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -19448,7 +20693,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -19462,7 +20707,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -19476,13 +20721,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -19492,7 +20747,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -19507,7 +20762,7 @@ ] }, { - "id": 406, + "id": 411, "name": "Factor", "kind": 256, "kindString": "Interface", @@ -19531,7 +20786,7 @@ }, "children": [ { - "id": 411, + "id": 416, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -19539,7 +20794,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 204, + "line": 205, "character": 2 } ], @@ -19549,7 +20804,7 @@ } }, { - "id": 409, + "id": 414, "name": "factor_type", "kind": 1024, "kindString": "Property", @@ -19560,7 +20815,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 199, + "line": 200, "character": 2 } ], @@ -19570,7 +20825,7 @@ } }, { - "id": 408, + "id": 413, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -19583,7 +20838,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 193, + "line": 194, "character": 2 } ], @@ -19593,7 +20848,7 @@ } }, { - "id": 407, + "id": 412, "name": "id", "kind": 1024, "kindString": "Property", @@ -19604,7 +20859,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 190, + "line": 191, "character": 2 } ], @@ -19614,7 +20869,7 @@ } }, { - "id": 410, + "id": 415, "name": "status", "kind": 1024, "kindString": "Property", @@ -19625,7 +20880,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 202, + "line": 203, "character": 2 } ], @@ -19644,7 +20899,7 @@ } }, { - "id": 412, + "id": 417, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -19652,7 +20907,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 205, + "line": 206, "character": 2 } ], @@ -19666,26 +20921,33 @@ { "title": "Properties", "kind": 1024, - "children": [411, 409, 408, 407, 410, 412] + "children": [ + 416, + 414, + 413, + 412, + 415, + 417 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 188, + "line": 189, "character": 17 } ] }, { - "id": 590, + "id": 610, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 591, + "id": 611, "name": "data", "kind": 1024, "kindString": "Property", @@ -19699,7 +20961,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 570, + "line": 596, "character": 2 } ], @@ -19709,7 +20971,7 @@ } }, { - "id": 592, + "id": 612, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -19722,7 +20984,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 572, + "line": 598, "character": 2 } ], @@ -19736,19 +20998,22 @@ { "title": "Properties", "kind": 1024, - "children": [591, 592] + "children": [ + 611, + 612 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 564, + "line": 590, "character": 17 } ] }, { - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -19764,14 +21029,14 @@ }, "children": [ { - "id": 753, + "id": 773, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 754, + "id": 774, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -19791,17 +21056,17 @@ }, "parameters": [ { - "id": 755, + "id": 775, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -19817,21 +21082,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "id", "kind": 1024, "kindString": "Property", @@ -19842,7 +21107,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 870, + "line": 896, "character": 2 } ], @@ -19852,7 +21117,7 @@ } }, { - "id": 736, + "id": 756, "name": "userId", "kind": 1024, "kindString": "Property", @@ -19863,7 +21128,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 873, + "line": 899, "character": 2 } ], @@ -19877,13 +21142,16 @@ { "title": "Properties", "kind": 1024, - "children": [735, 736] + "children": [ + 755, + 756 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 45 } ] @@ -19898,7 +21166,7 @@ "typeArguments": [ { "type": "reference", - "id": 724, + "id": 744, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -19910,14 +21178,14 @@ ] }, { - "id": 750, + "id": 770, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 751, + "id": 771, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -19927,17 +21195,17 @@ }, "parameters": [ { - "id": 752, + "id": 772, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -19953,21 +21221,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 747, + "id": 767, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 768, "name": "userId", "kind": 1024, "kindString": "Property", @@ -19978,7 +21246,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 920, "character": 2 } ], @@ -19992,13 +21260,15 @@ { "title": "Properties", "kind": 1024, - "children": [748] + "children": [ + 768 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 44 } ] @@ -20013,7 +21283,7 @@ "typeArguments": [ { "type": "reference", - "id": 737, + "id": 757, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -20029,19 +21299,22 @@ { "title": "Methods", "kind": 2048, - "children": [753, 750] + "children": [ + 773, + 770 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 902, + "line": 928, "character": 17 } ] }, { - "id": 704, + "id": 724, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -20051,14 +21324,14 @@ }, "children": [ { - "id": 708, + "id": 728, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 709, + "id": 729, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -20068,17 +21341,17 @@ }, "parameters": [ { - "id": 710, + "id": 730, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 628, + "id": 648, "name": "MFAChallengeParams", "dereferenced": { - "id": 628, + "id": 648, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -20086,21 +21359,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 630, + "id": 650, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -20111,7 +21384,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 680, "character": 2 } ], @@ -20125,13 +21398,15 @@ { "title": "Properties", "kind": 1024, - "children": [630] + "children": [ + 650 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 33 } ] @@ -20146,7 +21421,7 @@ "typeArguments": [ { "type": "reference", - "id": 672, + "id": 692, "name": "AuthMFAChallengeResponse" } ], @@ -20158,14 +21433,14 @@ ] }, { - "id": 717, + "id": 737, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 718, + "id": 738, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -20175,17 +21450,17 @@ }, "parameters": [ { - "id": 719, + "id": 739, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -20193,21 +21468,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 634, + "id": 654, "name": "code", "kind": 1024, "kindString": "Property", @@ -20218,7 +21493,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 661, + "line": 687, "character": 2 } ], @@ -20228,7 +21503,7 @@ } }, { - "id": 633, + "id": 653, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -20239,7 +21514,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 685, "character": 2 } ], @@ -20253,13 +21528,16 @@ { "title": "Properties", "kind": 1024, - "children": [634, 633] + "children": [ + 654, + 653 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 42 } ] @@ -20274,7 +21552,7 @@ "typeArguments": [ { "type": "reference", - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse" } ], @@ -20286,14 +21564,14 @@ ] }, { - "id": 705, + "id": 725, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 706, + "id": 726, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -20304,17 +21582,17 @@ }, "parameters": [ { - "id": 707, + "id": 727, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 635, "name": "MFAEnrollParams", "dereferenced": { - "id": 615, + "id": 635, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -20322,21 +21600,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 636, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 637, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -20347,7 +21625,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 629, + "line": 655, "character": 2 } ], @@ -20357,7 +21635,7 @@ } }, { - "id": 619, + "id": 639, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -20370,7 +21648,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 633, + "line": 659, "character": 2 } ], @@ -20380,7 +21658,7 @@ } }, { - "id": 618, + "id": 638, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -20393,7 +21671,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 631, + "line": 657, "character": 2 } ], @@ -20407,13 +21685,17 @@ { "title": "Properties", "kind": 1024, - "children": [617, 619, 618] + "children": [ + 637, + 639, + 638 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 30 } ] @@ -20428,7 +21710,7 @@ "typeArguments": [ { "type": "reference", - "id": 648, + "id": 668, "name": "AuthMFAEnrollResponse" } ], @@ -20440,14 +21722,14 @@ ] }, { - "id": 722, + "id": 742, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 723, + "id": 743, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -20461,7 +21743,7 @@ "typeArguments": [ { "type": "reference", - "id": 693, + "id": 713, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -20473,14 +21755,14 @@ ] }, { - "id": 720, + "id": 740, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 721, + "id": 741, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -20507,7 +21789,7 @@ "typeArguments": [ { "type": "reference", - "id": 682, + "id": 702, "name": "AuthMFAListFactorsResponse" } ], @@ -20519,14 +21801,14 @@ ] }, { - "id": 714, + "id": 734, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 715, + "id": 735, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -20536,17 +21818,17 @@ }, "parameters": [ { - "id": 716, + "id": 736, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "dereferenced": { - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -20554,21 +21836,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 621, + "id": 641, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 642, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -20579,7 +21861,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 638, + "line": 664, "character": 2 } ], @@ -20593,13 +21875,15 @@ { "title": "Properties", "kind": 1024, - "children": [622] + "children": [ + 642 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 32 } ] @@ -20614,7 +21898,7 @@ "typeArguments": [ { "type": "reference", - "id": 663, + "id": 683, "name": "AuthMFAUnenrollResponse" } ], @@ -20626,14 +21910,14 @@ ] }, { - "id": 711, + "id": 731, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 712, + "id": 732, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -20643,17 +21927,17 @@ }, "parameters": [ { - "id": 713, + "id": 733, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 623, + "id": 643, "name": "MFAVerifyParams", "dereferenced": { - "id": 623, + "id": 643, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -20661,21 +21945,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 644, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 646, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -20686,7 +21970,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 672, "character": 2 } ], @@ -20696,7 +21980,7 @@ } }, { - "id": 627, + "id": 647, "name": "code", "kind": 1024, "kindString": "Property", @@ -20707,7 +21991,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 675, "character": 2 } ], @@ -20717,7 +22001,7 @@ } }, { - "id": 625, + "id": 645, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -20728,7 +22012,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 669, "character": 2 } ], @@ -20742,13 +22026,17 @@ { "title": "Properties", "kind": 1024, - "children": [626, 627, 625] + "children": [ + 646, + 647, + 645 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 30 } ] @@ -20763,7 +22051,7 @@ "typeArguments": [ { "type": "reference", - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse" } ], @@ -20779,26 +22067,34 @@ { "title": "Methods", "kind": 2048, - "children": [708, 717, 705, 722, 720, 714, 711] + "children": [ + 728, + 737, + 725, + 742, + 740, + 734, + 731 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 789, + "line": 815, "character": 17 } ] }, { - "id": 383, + "id": 388, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 386, + "id": 391, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -20809,7 +22105,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 133, + "line": 134, "character": 2 } ], @@ -20819,7 +22115,7 @@ } }, { - "id": 389, + "id": 394, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -20832,7 +22128,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 145, + "line": 146, "character": 2 } ], @@ -20842,7 +22138,7 @@ } }, { - "id": 388, + "id": 393, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -20853,7 +22149,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 141, + "line": 142, "character": 2 } ], @@ -20863,7 +22159,7 @@ } }, { - "id": 385, + "id": 390, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", @@ -20876,7 +22172,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 129, + "line": 130, "character": 2 } ], @@ -20895,7 +22191,7 @@ } }, { - "id": 384, + "id": 389, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -20908,7 +22204,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, + "line": 125, "character": 2 } ], @@ -20927,7 +22223,7 @@ } }, { - "id": 387, + "id": 392, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -20938,7 +22234,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, + "line": 138, "character": 2 } ], @@ -20948,29 +22244,11 @@ } }, { - "id": 390, + "id": 395, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 146, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 391, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -20978,206 +22256,43 @@ "character": 2 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 396, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 148, + "character": 2 + } + ], "type": { "type": "reference", - "id": 420, + "id": 425, "name": "User", "dereferenced": { - "id": 420, + "id": 425, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 431, + "id": 436, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 228, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 219, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 413, - "name": "UserAppMetadata", - "dereferenced": { - "id": 413, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 414, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [414] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 208, - "character": 17 - } - ], - "indexSignature": { - "id": 415, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 416, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 424, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 221, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 425, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 222, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 232, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 231, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 432, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -21192,16 +22307,101 @@ }, { "id": 427, - "name": "email_change_sent_at", + "name": "app_metadata", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 224, + "line": 220, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 418, + "name": "UserAppMetadata", + "dereferenced": { + "id": 418, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 419, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 419 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 209, + "character": 17 + } + ], + "indexSignature": { + "id": 420, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 421, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 429, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, "character": 2 } ], @@ -21211,8 +22411,28 @@ } }, { - "id": 436, - "name": "email_confirmed_at", + "id": 430, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 440, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -21231,13 +22451,133 @@ } }, { - "id": 442, + "id": 439, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 232, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 437, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 230, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 432, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 234, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 447, "name": "factors", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 240, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 411, + "name": "Factor" + } + } + }, + { + "id": 426, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -21249,21 +22589,23 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, - "name": "Factor" + "id": 400, + "name": "UserIdentity" } } }, { - "id": 421, - "name": "id", + "id": 435, + "name": "invited_at", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 218, + "line": 228, "character": 2 } ], @@ -21273,8 +22615,8 @@ } }, { - "id": 441, - "name": "identities", + "id": 443, + "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { @@ -21283,22 +22625,38 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 238, + "line": 236, "character": 2 } ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 395, - "name": "UserIdentity" - } + "type": "intrinsic", + "name": "string" } }, { - "id": 430, - "name": "invited_at", + "id": 433, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 434, + "name": "new_phone", "kind": 1024, "kindString": "Property", "flags": { @@ -21318,7 +22676,27 @@ }, { "id": 438, - "name": "last_sign_in_at", + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 231, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 442, + "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -21337,87 +22715,7 @@ } }, { - "id": 428, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 225, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 429, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 226, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 433, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 230, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 437, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 234, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 426, + "id": 431, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -21427,7 +22725,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 224, "character": 2 } ], @@ -21437,33 +22735,13 @@ } }, { - "id": 439, + "id": 444, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 236, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 440, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -21477,7 +22755,27 @@ } }, { - "id": 423, + "id": 445, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 238, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 428, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -21485,16 +22783,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 221, "character": 2 } ], "type": { "type": "reference", - "id": 417, + "id": 422, "name": "UserMetadata", "dereferenced": { - "id": 417, + "id": 422, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -21502,19 +22800,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 214, "character": 17 } ], "indexSignature": { - "id": 418, + "id": 423, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 419, + "id": 424, "name": "key", "kind": 32768, "flags": {}, @@ -21538,15 +22836,35 @@ "title": "Properties", "kind": 1024, "children": [ - 431, 422, 424, 425, 435, 434, 432, 427, 436, 442, 421, 441, 430, 438, 428, - 429, 433, 437, 426, 439, 440, 423 + 436, + 427, + 429, + 430, + 440, + 439, + 437, + 432, + 441, + 447, + 426, + 446, + 435, + 443, + 433, + 434, + 438, + 442, + 431, + 444, + 445, + 428 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 217, + "line": 218, "character": 17 } ] @@ -21558,26 +22876,35 @@ { "title": "Properties", "kind": 1024, - "children": [386, 389, 388, 385, 384, 387, 390, 391] + "children": [ + 391, + 394, + 393, + 390, + 389, + 392, + 395, + 396 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 121, "character": 17 } ] }, { - "id": 457, + "id": 464, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 458, + "id": 465, "name": "id", "kind": 1024, "kindString": "Property", @@ -21588,7 +22915,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 329, "character": 2 } ], @@ -21598,7 +22925,7 @@ } }, { - "id": 459, + "id": 466, "name": "callback", "kind": 2048, "kindString": "Method", @@ -21606,13 +22933,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 325, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 460, + "id": 467, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -21622,17 +22949,17 @@ }, "parameters": [ { - "id": 461, + "id": 468, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 322, + "id": 327, "name": "AuthChangeEvent", "dereferenced": { - "id": 322, + "id": 327, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -21640,7 +22967,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 25, + "line": 26, "character": 12 } ], @@ -21672,7 +22999,7 @@ "value": "USER_UPDATED" }, { - "id": 321, + "id": 326, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -21680,7 +23007,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, + "line": 24, "character": 12 } ], @@ -21695,7 +23022,7 @@ } }, { - "id": 462, + "id": 469, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -21709,7 +23036,7 @@ }, { "type": "reference", - "id": 383, + "id": 388, "name": "Session" } ] @@ -21724,7 +23051,7 @@ ] }, { - "id": 463, + "id": 470, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -21732,13 +23059,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 329, + "line": 337, "character": 2 } ], "signatures": [ { - "id": 464, + "id": 471, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -21758,31 +23085,36 @@ { "title": "Properties", "kind": 1024, - "children": [458] + "children": [ + 465 + ] }, { "title": "Methods", "kind": 2048, - "children": [459, 463] + "children": [ + 466, + 470 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 317, + "line": 325, "character": 17 } ] }, { - "id": 465, + "id": 472, "name": "UpdatableFactorAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 466, + "id": 473, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -21790,7 +23122,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 333, + "line": 341, "character": 2 } ], @@ -21804,213 +23136,34 @@ { "title": "Properties", "kind": 1024, - "children": [466] + "children": [ + 473 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 332, + "line": 340, "character": 17 } ] }, { - "id": 420, + "id": 425, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 431, + "id": 436, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 228, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 219, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 413, - "name": "UserAppMetadata", - "dereferenced": { - "id": 413, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 414, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [414] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 208, - "character": 17 - } - ], - "indexSignature": { - "id": 415, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 416, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 424, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 221, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 425, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 222, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 232, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 231, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 432, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -22025,16 +23178,101 @@ }, { "id": 427, - "name": "email_change_sent_at", + "name": "app_metadata", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 224, + "line": 220, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 418, + "name": "UserAppMetadata", + "dereferenced": { + "id": 418, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 419, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 419 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 209, + "character": 17 + } + ], + "indexSignature": { + "id": 420, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 421, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 429, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, "character": 2 } ], @@ -22044,8 +23282,28 @@ } }, { - "id": 436, - "name": "email_confirmed_at", + "id": 430, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 440, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -22064,13 +23322,133 @@ } }, { - "id": 442, + "id": 439, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 232, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 437, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 230, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 432, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 234, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 447, "name": "factors", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 240, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 411, + "name": "Factor" + } + } + }, + { + "id": 426, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -22082,21 +23460,23 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, - "name": "Factor" + "id": 400, + "name": "UserIdentity" } } }, { - "id": 421, - "name": "id", + "id": 435, + "name": "invited_at", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 218, + "line": 228, "character": 2 } ], @@ -22106,8 +23486,8 @@ } }, { - "id": 441, - "name": "identities", + "id": 443, + "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { @@ -22116,22 +23496,38 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 238, + "line": 236, "character": 2 } ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 395, - "name": "UserIdentity" - } + "type": "intrinsic", + "name": "string" } }, { - "id": 430, - "name": "invited_at", + "id": 433, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 434, + "name": "new_phone", "kind": 1024, "kindString": "Property", "flags": { @@ -22151,7 +23547,27 @@ }, { "id": 438, - "name": "last_sign_in_at", + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 231, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 442, + "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -22170,87 +23586,7 @@ } }, { - "id": 428, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 225, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 429, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 226, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 433, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 230, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 437, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 234, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 426, + "id": 431, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -22260,7 +23596,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 224, "character": 2 } ], @@ -22270,33 +23606,13 @@ } }, { - "id": 439, + "id": 444, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 236, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 440, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -22310,7 +23626,27 @@ } }, { - "id": 423, + "id": 445, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 238, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 428, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -22318,16 +23654,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 221, "character": 2 } ], "type": { "type": "reference", - "id": 417, + "id": 422, "name": "UserMetadata", "dereferenced": { - "id": 417, + "id": 422, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -22335,19 +23671,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 214, "character": 17 } ], "indexSignature": { - "id": 418, + "id": 423, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 419, + "id": 424, "name": "key", "kind": 32768, "flags": {}, @@ -22371,28 +23707,48 @@ "title": "Properties", "kind": 1024, "children": [ - 431, 422, 424, 425, 435, 434, 432, 427, 436, 442, 421, 441, 430, 438, 428, 429, 433, - 437, 426, 439, 440, 423 + 436, + 427, + 429, + 430, + 440, + 439, + 437, + 432, + 441, + 447, + 426, + 446, + 435, + 443, + 433, + 434, + 438, + 442, + 431, + 444, + 445, + 428 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 217, + "line": 218, "character": 17 } ] }, { - "id": 413, + "id": 418, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 414, + "id": 419, "name": "provider", "kind": 1024, "kindString": "Property", @@ -22402,7 +23758,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 209, + "line": 210, "character": 2 } ], @@ -22416,25 +23772,27 @@ { "title": "Properties", "kind": 1024, - "children": [414] + "children": [ + 419 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 209, "character": 17 } ], "indexSignature": { - "id": 415, + "id": 420, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 416, + "id": 421, "name": "key", "kind": 32768, "flags": {}, @@ -22451,14 +23809,14 @@ } }, { - "id": 443, + "id": 448, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 447, + "id": 453, "name": "data", "kind": 1024, "kindString": "Property", @@ -22472,7 +23830,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 264, + "line": 272, "character": 2 } ], @@ -22482,7 +23840,7 @@ } }, { - "id": 444, + "id": 449, "name": "email", "kind": 1024, "kindString": "Property", @@ -22495,7 +23853,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -22505,7 +23863,31 @@ } }, { - "id": 446, + "id": 452, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, "name": "password", "kind": 1024, "kindString": "Property", @@ -22518,7 +23900,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -22528,7 +23910,7 @@ } }, { - "id": 445, + "id": 450, "name": "phone", "kind": 1024, "kindString": "Property", @@ -22541,7 +23923,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -22555,119 +23937,38 @@ { "title": "Properties", "kind": 1024, - "children": [447, 444, 446, 445] + "children": [ + 453, + 449, + 452, + 451, + 450 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 242, + "line": 243, "character": 17 } ] }, { - "id": 395, + "id": 400, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 403, + "id": 408, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 176, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 396, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 170, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 398, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 172, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 399, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 400, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 401, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 404, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -22681,15 +23982,15 @@ } }, { - "id": 402, - "name": "provider", + "id": 401, + "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 175, + "line": 171, "character": 2 } ], @@ -22699,8 +24000,57 @@ } }, { - "id": 405, - "name": "updated_at", + "id": 403, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 173, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 404, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 405, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 406, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 409, + "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { @@ -22719,7 +24069,45 @@ } }, { - "id": 397, + "id": 407, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 176, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 410, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 179, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 402, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -22727,7 +24115,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 171, + "line": 172, "character": 2 } ], @@ -22741,19 +24129,27 @@ { "title": "Properties", "kind": 1024, - "children": [403, 396, 398, 404, 402, 405, 397] + "children": [ + 408, + 401, + 403, + 409, + 407, + 410, + 402 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 169, + "line": 170, "character": 17 } ] }, { - "id": 417, + "id": 422, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -22761,19 +24157,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 214, "character": 17 } ], "indexSignature": { - "id": 418, + "id": 423, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 419, + "id": 424, "name": "key", "kind": 32768, "flags": {}, @@ -22790,14 +24186,14 @@ } }, { - "id": 545, + "id": 552, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 546, + "id": 553, "name": "email", "kind": 1024, "kindString": "Property", @@ -22808,7 +24204,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 492, + "line": 500, "character": 2 } ], @@ -22818,7 +24214,7 @@ } }, { - "id": 549, + "id": 556, "name": "options", "kind": 1024, "kindString": "Property", @@ -22828,21 +24224,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 497, + "line": 505, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 550, + "id": 557, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 559, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22855,7 +24251,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 501, + "line": 509, "character": 4 } ], @@ -22865,7 +24261,7 @@ } }, { - "id": 551, + "id": 558, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -22878,7 +24274,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 499, + "line": 507, "character": 4 } ], @@ -22892,14 +24288,17 @@ { "title": "Properties", "kind": 1024, - "children": [552, 551] + "children": [ + 559, + 558 + ] } ] } } }, { - "id": 547, + "id": 554, "name": "token", "kind": 1024, "kindString": "Property", @@ -22910,7 +24309,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 494, + "line": 502, "character": 2 } ], @@ -22920,7 +24319,7 @@ } }, { - "id": 548, + "id": 555, "name": "type", "kind": 1024, "kindString": "Property", @@ -22931,16 +24330,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 496, + "line": 504, "character": 2 } ], "type": { "type": "reference", - "id": 554, + "id": 561, "name": "EmailOtpType", "dereferenced": { - "id": 554, + "id": 561, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -22948,7 +24347,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 514, "character": 12 } ], @@ -22989,26 +24388,31 @@ { "title": "Properties", "kind": 1024, - "children": [546, 549, 547, 548] + "children": [ + 553, + 556, + 554, + 555 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 490, + "line": 498, "character": 17 } ] }, { - "id": 537, + "id": 544, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 541, + "id": 548, "name": "options", "kind": 1024, "kindString": "Property", @@ -23018,21 +24422,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 478, + "line": 486, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 542, + "id": 549, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 551, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23051,7 +24455,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 495, "character": 4 } ], @@ -23061,7 +24465,7 @@ } }, { - "id": 543, + "id": 550, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -23074,7 +24478,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 480, + "line": 488, "character": 4 } ], @@ -23088,14 +24492,17 @@ { "title": "Properties", "kind": 1024, - "children": [544, 543] + "children": [ + 551, + 550 + ] } ] } } }, { - "id": 538, + "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", @@ -23106,7 +24513,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 473, + "line": 481, "character": 2 } ], @@ -23116,7 +24523,7 @@ } }, { - "id": 539, + "id": 546, "name": "token", "kind": 1024, "kindString": "Property", @@ -23127,7 +24534,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 475, + "line": 483, "character": 2 } ], @@ -23137,7 +24544,7 @@ } }, { - "id": 540, + "id": 547, "name": "type", "kind": 1024, "kindString": "Property", @@ -23148,16 +24555,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 477, + "line": 485, "character": 2 } ], "type": { "type": "reference", - "id": 553, + "id": 560, "name": "MobileOtpType", "dereferenced": { - "id": 553, + "id": 560, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -23165,7 +24572,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 513, "character": 12 } ], @@ -23190,19 +24597,24 @@ { "title": "Properties", "kind": 1024, - "children": [541, 538, 539, 540] + "children": [ + 548, + 545, + 546, + 547 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 479, "character": 17 } ] }, { - "id": 322, + "id": 327, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -23210,7 +24622,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 25, + "line": 26, "character": 12 } ], @@ -23242,7 +24654,7 @@ "value": "USER_UPDATED" }, { - "id": 321, + "id": 326, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -23250,7 +24662,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, + "line": 24, "character": 12 } ], @@ -23263,7 +24675,7 @@ } }, { - "id": 321, + "id": 326, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -23271,7 +24683,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, + "line": 24, "character": 12 } ], @@ -23281,7 +24693,7 @@ } }, { - "id": 515, + "id": 522, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -23289,7 +24701,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 439, + "line": 447, "character": 12 } ], @@ -23308,7 +24720,7 @@ } }, { - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -23324,21 +24736,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "id", "kind": 1024, "kindString": "Property", @@ -23349,7 +24761,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 870, + "line": 896, "character": 2 } ], @@ -23359,7 +24771,7 @@ } }, { - "id": 736, + "id": 756, "name": "userId", "kind": 1024, "kindString": "Property", @@ -23370,7 +24782,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 873, + "line": 899, "character": 2 } ], @@ -23384,13 +24796,16 @@ { "title": "Properties", "kind": 1024, - "children": [735, 736] + "children": [ + 755, + 756 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 45 } ] @@ -23398,7 +24813,7 @@ } }, { - "id": 724, + "id": 744, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", @@ -23414,7 +24829,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 855, + "line": 881, "character": 12 } ], @@ -23424,14 +24839,14 @@ { "type": "reflection", "declaration": { - "id": 725, + "id": 745, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 726, + "id": 746, "name": "data", "kind": 1024, "kindString": "Property", @@ -23439,21 +24854,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 857, + "line": 883, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 727, + "id": 747, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 728, + "id": 748, "name": "id", "kind": 1024, "kindString": "Property", @@ -23464,7 +24879,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 859, + "line": 885, "character": 8 } ], @@ -23478,13 +24893,15 @@ { "title": "Properties", "kind": 1024, - "children": [728] + "children": [ + 748 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 857, + "line": 883, "character": 12 } ] @@ -23492,7 +24909,7 @@ } }, { - "id": 729, + "id": 749, "name": "error", "kind": 1024, "kindString": "Property", @@ -23500,7 +24917,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 861, + "line": 887, "character": 6 } ], @@ -23514,13 +24931,16 @@ { "title": "Properties", "kind": 1024, - "children": [726, 729] + "children": [ + 746, + 749 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 856, + "line": 882, "character": 4 } ] @@ -23529,14 +24949,14 @@ { "type": "reflection", "declaration": { - "id": 730, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 751, "name": "data", "kind": 1024, "kindString": "Property", @@ -23544,7 +24964,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 863, + "line": 889, "character": 6 } ], @@ -23554,7 +24974,7 @@ } }, { - "id": 732, + "id": 752, "name": "error", "kind": 1024, "kindString": "Property", @@ -23562,13 +24982,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 863, + "line": 889, "character": 18 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -23577,13 +24997,16 @@ { "title": "Properties", "kind": 1024, - "children": [731, 732] + "children": [ + 751, + 752 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 863, + "line": 889, "character": 4 } ] @@ -23593,7 +25016,7 @@ } }, { - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -23609,21 +25032,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 747, + "id": 767, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 768, "name": "userId", "kind": 1024, "kindString": "Property", @@ -23634,7 +25057,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 920, "character": 2 } ], @@ -23648,13 +25071,15 @@ { "title": "Properties", "kind": 1024, - "children": [748] + "children": [ + 768 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 44 } ] @@ -23662,7 +25087,7 @@ } }, { - "id": 737, + "id": 757, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -23678,7 +25103,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 879, + "line": 905, "character": 12 } ], @@ -23688,14 +25113,14 @@ { "type": "reflection", "declaration": { - "id": 738, + "id": 758, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 739, + "id": 759, "name": "data", "kind": 1024, "kindString": "Property", @@ -23703,21 +25128,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 881, + "line": 907, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 740, + "id": 760, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 741, + "id": 761, "name": "factors", "kind": 1024, "kindString": "Property", @@ -23728,7 +25153,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 883, + "line": 909, "character": 8 } ], @@ -23736,7 +25161,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, + "id": 411, "name": "Factor" } } @@ -23746,13 +25171,15 @@ { "title": "Properties", "kind": 1024, - "children": [741] + "children": [ + 761 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 881, + "line": 907, "character": 12 } ] @@ -23760,7 +25187,7 @@ } }, { - "id": 742, + "id": 762, "name": "error", "kind": 1024, "kindString": "Property", @@ -23768,7 +25195,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 885, + "line": 911, "character": 6 } ], @@ -23782,13 +25209,16 @@ { "title": "Properties", "kind": 1024, - "children": [739, 742] + "children": [ + 759, + 762 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 880, + "line": 906, "character": 4 } ] @@ -23797,14 +25227,14 @@ { "type": "reflection", "declaration": { - "id": 743, + "id": 763, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 764, "name": "data", "kind": 1024, "kindString": "Property", @@ -23812,7 +25242,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 887, + "line": 913, "character": 6 } ], @@ -23822,7 +25252,7 @@ } }, { - "id": 745, + "id": 765, "name": "error", "kind": 1024, "kindString": "Property", @@ -23830,13 +25260,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 887, + "line": 913, "character": 18 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -23845,13 +25275,16 @@ { "title": "Properties", "kind": 1024, - "children": [744, 745] + "children": [ + 764, + 765 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 887, + "line": 913, "character": 4 } ] @@ -23861,7 +25294,7 @@ } }, { - "id": 672, + "id": 692, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -23869,7 +25302,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 732, + "line": 758, "character": 12 } ], @@ -23879,14 +25312,14 @@ { "type": "reflection", "declaration": { - "id": 673, + "id": 693, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 674, + "id": 694, "name": "data", "kind": 1024, "kindString": "Property", @@ -23894,21 +25327,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 734, + "line": 760, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 675, + "id": 695, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 677, + "id": 697, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -23919,7 +25352,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 739, + "line": 765, "character": 8 } ], @@ -23929,7 +25362,7 @@ } }, { - "id": 676, + "id": 696, "name": "id", "kind": 1024, "kindString": "Property", @@ -23940,7 +25373,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 736, + "line": 762, "character": 8 } ], @@ -23954,13 +25387,16 @@ { "title": "Properties", "kind": 1024, - "children": [677, 676] + "children": [ + 697, + 696 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 734, + "line": 760, "character": 12 } ] @@ -23968,7 +25404,335 @@ } }, { - "id": 678, + "id": 698, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 767, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 694, + 698 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 759, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 699, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 700, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 701, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 700, + 701 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 668, + "name": "AuthMFAEnrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 715, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 669, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 670, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 717, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 671, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 672, + "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": 719, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 674, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 725, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 675, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 676, + "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": 729, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 677, + "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": 734, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 678, + "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": 738, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 676, + 677, + 678 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 725, + "character": 14 + } + ] + } + } + }, + { + "id": 673, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor. Only `totp` supported for now." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 722, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 672, + 674, + 673 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 717, + "character": 12 + } + ] + } + } + }, + { + "id": 679, "name": "error", "kind": 1024, "kindString": "Property", @@ -23990,13 +25754,16 @@ { "title": "Properties", "kind": 1024, - "children": [674, 678] + "children": [ + 670, + 679 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 716, "character": 4 } ] @@ -24005,14 +25772,14 @@ { "type": "reflection", "declaration": { - "id": 679, + "id": 680, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 680, + "id": 681, "name": "data", "kind": 1024, "kindString": "Property", @@ -24020,7 +25787,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 743, + "line": 744, "character": 6 } ], @@ -24030,7 +25797,7 @@ } }, { - "id": 681, + "id": 682, "name": "error", "kind": 1024, "kindString": "Property", @@ -24038,13 +25805,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 743, - "character": 18 + "line": 745, + "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -24053,7 +25820,10 @@ { "title": "Properties", "kind": 1024, - "children": [680, 681] + "children": [ + 681, + 682 + ] } ], "sources": [ @@ -24069,321 +25839,7 @@ } }, { - "id": 648, - "name": "AuthMFAEnrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 689, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 650, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 691, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 651, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 652, - "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": 693, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "TOTP enrollment information." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 699, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 655, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 656, - "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": 703, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 657, - "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": 708, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "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": 712, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [656, 657, 658] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 699, - "character": 14 - } - ] - } - } - }, - { - "id": 653, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of MFA factor. Only `totp` supported for now." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 696, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [652, 654, 653] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 691, - "character": 12 - } - ] - } - } - }, - { - "id": 659, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 715, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [650, 659] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 690, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 660, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 661, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 718, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 662, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 719, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [661, 662] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 717, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 693, + "id": 713, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", @@ -24391,7 +25847,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 760, + "line": 786, "character": 12 } ], @@ -24401,14 +25857,14 @@ { "type": "reflection", "declaration": { - "id": 694, + "id": 714, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 695, + "id": 715, "name": "data", "kind": 1024, "kindString": "Property", @@ -24416,21 +25872,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 762, + "line": 788, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 696, + "id": 716, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 699, + "id": 719, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", @@ -24441,7 +25897,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 779, + "line": 805, "character": 8 } ], @@ -24449,13 +25905,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 392, + "id": 397, "name": "AMREntry" } } }, { - "id": 697, + "id": 717, "name": "currentLevel", "kind": 1024, "kindString": "Property", @@ -24466,7 +25922,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 764, + "line": 790, "character": 8 } ], @@ -24475,7 +25931,7 @@ "types": [ { "type": "reference", - "id": 692, + "id": 712, "name": "AuthenticatorAssuranceLevels" }, { @@ -24486,7 +25942,7 @@ } }, { - "id": 698, + "id": 718, "name": "nextLevel", "kind": 1024, "kindString": "Property", @@ -24503,7 +25959,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 772, + "line": 798, "character": 8 } ], @@ -24512,7 +25968,7 @@ "types": [ { "type": "reference", - "id": 692, + "id": 712, "name": "AuthenticatorAssuranceLevels" }, { @@ -24527,13 +25983,17 @@ { "title": "Properties", "kind": 1024, - "children": [699, 697, 698] + "children": [ + 719, + 717, + 718 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 762, + "line": 788, "character": 12 } ] @@ -24541,7 +26001,7 @@ } }, { - "id": 700, + "id": 720, "name": "error", "kind": 1024, "kindString": "Property", @@ -24549,7 +26009,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 781, + "line": 807, "character": 6 } ], @@ -24563,13 +26023,16 @@ { "title": "Properties", "kind": 1024, - "children": [695, 700] + "children": [ + 715, + 720 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 761, + "line": 787, "character": 4 } ] @@ -24578,14 +26041,14 @@ { "type": "reflection", "declaration": { - "id": 701, + "id": 721, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 702, + "id": 722, "name": "data", "kind": 1024, "kindString": "Property", @@ -24593,7 +26056,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 783, + "line": 809, "character": 6 } ], @@ -24603,7 +26066,7 @@ } }, { - "id": 703, + "id": 723, "name": "error", "kind": 1024, "kindString": "Property", @@ -24611,13 +26074,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 783, + "line": 809, "character": 18 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -24626,13 +26089,16 @@ { "title": "Properties", "kind": 1024, - "children": [702, 703] + "children": [ + 722, + 723 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 783, + "line": 809, "character": 4 } ] @@ -24642,7 +26108,7 @@ } }, { - "id": 682, + "id": 702, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -24650,7 +26116,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 745, + "line": 771, "character": 12 } ], @@ -24660,14 +26126,14 @@ { "type": "reflection", "declaration": { - "id": 683, + "id": 703, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 684, + "id": 704, "name": "data", "kind": 1024, "kindString": "Property", @@ -24675,21 +26141,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 747, + "line": 773, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 685, + "id": 705, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 686, + "id": 706, "name": "all", "kind": 1024, "kindString": "Property", @@ -24700,7 +26166,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 749, + "line": 775, "character": 8 } ], @@ -24708,13 +26174,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, + "id": 411, "name": "Factor" } } }, { - "id": 687, + "id": 707, "name": "totp", "kind": 1024, "kindString": "Property", @@ -24725,7 +26191,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 752, + "line": 778, "character": 8 } ], @@ -24733,7 +26199,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, + "id": 411, "name": "Factor" } } @@ -24743,13 +26209,211 @@ { "title": "Properties", "kind": 1024, - "children": [686, 687] + "children": [ + 706, + 707 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 747, + "line": 773, + "character": 12 + } + ] + } + } + }, + { + "id": 708, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 780, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 704, + 708 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 772, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 709, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 710, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 711, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 710, + 711 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 683, + "name": "AuthMFAUnenrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 748, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 684, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 685, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 750, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 686, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 687, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 752, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 687 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 750, "character": 12 } ] @@ -24779,13 +26443,16 @@ { "title": "Properties", "kind": 1024, - "children": [684, 688] + "children": [ + 685, + 688 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 746, + "line": 749, "character": 4 } ] @@ -24833,7 +26500,7 @@ ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -24842,7 +26509,10 @@ { "title": "Properties", "kind": 1024, - "children": [690, 691] + "children": [ + 690, + 691 + ] } ], "sources": [ @@ -24858,194 +26528,7 @@ } }, { - "id": 663, - "name": "AuthMFAUnenrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 722, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 664, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 665, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 724, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 666, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 667, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 726, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [667] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 724, - "character": 12 - } - ] - } - } - }, - { - "id": 668, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 728, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [665, 668] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 723, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 669, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 670, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 671, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [670, 671] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -25053,7 +26536,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 664, + "line": 690, "character": 12 } ], @@ -25063,14 +26546,14 @@ { "type": "reflection", "declaration": { - "id": 636, + "id": 656, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 637, + "id": 657, "name": "data", "kind": 1024, "kindString": "Property", @@ -25078,21 +26561,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 692, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 638, + "id": 658, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 639, + "id": 659, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -25103,7 +26586,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 668, + "line": 694, "character": 8 } ], @@ -25113,7 +26596,7 @@ } }, { - "id": 641, + "id": 661, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -25124,7 +26607,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 674, + "line": 700, "character": 8 } ], @@ -25134,7 +26617,7 @@ } }, { - "id": 642, + "id": 662, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -25145,7 +26628,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 677, + "line": 703, "character": 8 } ], @@ -25155,7 +26638,7 @@ } }, { - "id": 640, + "id": 660, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -25166,7 +26649,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 697, "character": 8 } ], @@ -25176,7 +26659,7 @@ } }, { - "id": 643, + "id": 663, "name": "user", "kind": 1024, "kindString": "Property", @@ -25187,13 +26670,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 680, + "line": 706, "character": 8 } ], "type": { "type": "reference", - "id": 420, + "id": 425, "name": "User" } } @@ -25202,13 +26685,19 @@ { "title": "Properties", "kind": 1024, - "children": [639, 641, 642, 640, 643] + "children": [ + 659, + 661, + 662, + 660, + 663 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 692, "character": 12 } ] @@ -25216,7 +26705,7 @@ } }, { - "id": 644, + "id": 664, "name": "error", "kind": 1024, "kindString": "Property", @@ -25224,7 +26713,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 708, "character": 6 } ], @@ -25238,13 +26727,16 @@ { "title": "Properties", "kind": 1024, - "children": [637, 644] + "children": [ + 657, + 664 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 665, + "line": 691, "character": 4 } ] @@ -25253,14 +26745,14 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 646, + "id": 666, "name": "data", "kind": 1024, "kindString": "Property", @@ -25268,7 +26760,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 685, + "line": 711, "character": 6 } ], @@ -25278,7 +26770,7 @@ } }, { - "id": 647, + "id": 667, "name": "error", "kind": 1024, "kindString": "Property", @@ -25286,13 +26778,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 686, + "line": 712, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -25301,13 +26793,16 @@ { "title": "Properties", "kind": 1024, - "children": [646, 647] + "children": [ + 666, + 667 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 684, + "line": 710, "character": 4 } ] @@ -25317,7 +26812,7 @@ } }, { - "id": 337, + "id": 342, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -25325,7 +26820,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 56, "character": 12 } ], @@ -25335,14 +26830,14 @@ { "type": "reflection", "declaration": { - "id": 338, + "id": 343, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 339, + "id": 344, "name": "data", "kind": 1024, "kindString": "Property", @@ -25350,25 +26845,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 57, + "line": 58, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 340, + "id": 345, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 347, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 60, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 346, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -25381,35 +26904,7 @@ "types": [ { "type": "reference", - "id": 383, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 341, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 420, + "id": 425, "name": "User" }, { @@ -25424,13 +26919,16 @@ { "title": "Properties", "kind": 1024, - "children": [342, 341] + "children": [ + 347, + 346 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 57, + "line": 58, "character": 12 } ] @@ -25438,7 +26936,7 @@ } }, { - "id": 343, + "id": 348, "name": "error", "kind": 1024, "kindString": "Property", @@ -25446,7 +26944,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 61, + "line": 62, "character": 6 } ], @@ -25460,13 +26958,16 @@ { "title": "Properties", "kind": 1024, - "children": [339, 343] + "children": [ + 344, + 348 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 4 } ] @@ -25475,14 +26976,14 @@ { "type": "reflection", "declaration": { - "id": 344, + "id": 349, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 345, + "id": 350, "name": "data", "kind": 1024, "kindString": "Property", @@ -25490,25 +26991,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 346, + "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 348, + "id": 353, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 352, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -25520,37 +27039,22 @@ "type": "literal", "value": null } - }, - { - "id": 347, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 65, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [348, 347] + "children": [ + 353, + 352 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 12 } ] @@ -25558,7 +27062,7 @@ } }, { - "id": 349, + "id": 354, "name": "error", "kind": 1024, "kindString": "Property", @@ -25566,13 +27070,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 68, + "line": 69, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -25581,13 +27085,16 @@ { "title": "Properties", "kind": 1024, - "children": [345, 349] + "children": [ + 350, + 354 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, + "line": 64, "character": 4 } ] @@ -25597,7 +27104,7 @@ } }, { - "id": 692, + "id": 712, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -25605,7 +27112,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 758, + "line": 784, "character": 12 } ], @@ -25624,7 +27131,7 @@ } }, { - "id": 760, + "id": 780, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -25632,7 +27139,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 933, + "line": 959, "character": 12 } ], @@ -25642,14 +27149,14 @@ { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "error", "kind": 1024, "kindString": "Property", @@ -25657,7 +27164,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 936, + "line": 962, "character": 6 } ], @@ -25667,7 +27174,7 @@ } }, { - "id": 762, + "id": 782, "name": "session", "kind": 1024, "kindString": "Property", @@ -25675,13 +27182,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 935, + "line": 961, "character": 6 } ], "type": { "type": "reference", - "id": 383, + "id": 388, "name": "Session" } } @@ -25690,13 +27197,16 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [ + 783, + 782 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 934, + "line": 960, "character": 4 } ] @@ -25705,14 +27215,14 @@ { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 766, + "id": 786, "name": "error", "kind": 1024, "kindString": "Property", @@ -25720,18 +27230,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 940, + "line": 966, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } }, { - "id": 765, + "id": 785, "name": "session", "kind": 1024, "kindString": "Property", @@ -25739,7 +27249,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 939, + "line": 965, "character": 6 } ], @@ -25753,13 +27263,16 @@ { "title": "Properties", "kind": 1024, - "children": [766, 765] + "children": [ + 786, + 785 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 938, + "line": 964, "character": 4 } ] @@ -25769,7 +27282,7 @@ } }, { - "id": 554, + "id": 561, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -25777,7 +27290,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 514, "character": 12 } ], @@ -25812,7 +27325,7 @@ } }, { - "id": 584, + "id": 604, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -25820,21 +27333,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 607, "name": "email", "kind": 1024, "kindString": "Property", @@ -25845,7 +27358,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 556, + "line": 582, "character": 2 } ], @@ -25855,7 +27368,7 @@ } }, { - "id": 588, + "id": 608, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -25866,7 +27379,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 560, + "line": 586, "character": 2 } ], @@ -25876,7 +27389,7 @@ } }, { - "id": 589, + "id": 609, "name": "options", "kind": 1024, "kindString": "Property", @@ -25886,7 +27399,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 587, "character": 2 } ], @@ -25895,7 +27408,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -25909,7 +27422,7 @@ } }, { - "id": 586, + "id": 606, "name": "type", "kind": 1024, "kindString": "Property", @@ -25917,7 +27430,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 554, + "line": 580, "character": 2 } ], @@ -25940,13 +27453,18 @@ { "title": "Properties", "kind": 1024, - "children": [587, 588, 589, 586] + "children": [ + 607, + 608, + 609, + 606 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 44 } ] @@ -25954,7 +27472,7 @@ } }, { - "id": 574, + "id": 594, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -25962,21 +27480,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 597, "name": "email", "kind": 1024, "kindString": "Property", @@ -25987,7 +27505,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 542, + "line": 568, "character": 2 } ], @@ -25997,7 +27515,7 @@ } }, { - "id": 578, + "id": 598, "name": "options", "kind": 1024, "kindString": "Property", @@ -26007,7 +27525,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 543, + "line": 569, "character": 2 } ], @@ -26016,7 +27534,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -26039,7 +27557,7 @@ } }, { - "id": 576, + "id": 596, "name": "type", "kind": 1024, "kindString": "Property", @@ -26047,7 +27565,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 540, + "line": 566, "character": 2 } ], @@ -26070,13 +27588,17 @@ { "title": "Properties", "kind": 1024, - "children": [577, 578, 576] + "children": [ + 597, + 598, + 596 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 46 } ] @@ -26084,7 +27606,7 @@ } }, { - "id": 593, + "id": 613, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26092,7 +27614,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 601, "character": 12 } ], @@ -26100,7 +27622,7 @@ "type": "union", "types": [ { - "id": 568, + "id": 588, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26108,21 +27630,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 589, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 571, + "id": 591, "name": "email", "kind": 1024, "kindString": "Property", @@ -26130,7 +27652,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 534, + "line": 560, "character": 2 } ], @@ -26140,7 +27662,7 @@ } }, { - "id": 573, + "id": 593, "name": "options", "kind": 1024, "kindString": "Property", @@ -26150,7 +27672,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 536, + "line": 562, "character": 2 } ], @@ -26159,7 +27681,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -26182,7 +27704,7 @@ } }, { - "id": 572, + "id": 592, "name": "password", "kind": 1024, "kindString": "Property", @@ -26190,7 +27712,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 535, + "line": 561, "character": 2 } ], @@ -26200,7 +27722,7 @@ } }, { - "id": 570, + "id": 590, "name": "type", "kind": 1024, "kindString": "Property", @@ -26208,7 +27730,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 533, + "line": 559, "character": 2 } ], @@ -26222,13 +27744,18 @@ { "title": "Properties", "kind": 1024, - "children": [571, 573, 572, 570] + "children": [ + 591, + 593, + 592, + 590 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 39 } ] @@ -26236,7 +27763,7 @@ } }, { - "id": 574, + "id": 594, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26244,21 +27771,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 597, "name": "email", "kind": 1024, "kindString": "Property", @@ -26269,7 +27796,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 542, + "line": 568, "character": 2 } ], @@ -26279,7 +27806,7 @@ } }, { - "id": 578, + "id": 598, "name": "options", "kind": 1024, "kindString": "Property", @@ -26289,7 +27816,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 543, + "line": 569, "character": 2 } ], @@ -26298,7 +27825,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -26321,7 +27848,7 @@ } }, { - "id": 576, + "id": 596, "name": "type", "kind": 1024, "kindString": "Property", @@ -26329,7 +27856,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 540, + "line": 566, "character": 2 } ], @@ -26352,13 +27879,17 @@ { "title": "Properties", "kind": 1024, - "children": [577, 578, 576] + "children": [ + 597, + 598, + 596 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 46 } ] @@ -26366,7 +27897,7 @@ } }, { - "id": 579, + "id": 599, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26374,21 +27905,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 602, "name": "email", "kind": 1024, "kindString": "Property", @@ -26399,7 +27930,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 575, "character": 2 } ], @@ -26409,7 +27940,7 @@ } }, { - "id": 583, + "id": 603, "name": "options", "kind": 1024, "kindString": "Property", @@ -26419,7 +27950,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 550, + "line": 576, "character": 2 } ], @@ -26428,7 +27959,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -26442,7 +27973,7 @@ } }, { - "id": 581, + "id": 601, "name": "type", "kind": 1024, "kindString": "Property", @@ -26450,7 +27981,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 547, + "line": 573, "character": 2 } ], @@ -26464,13 +27995,17 @@ { "title": "Properties", "kind": 1024, - "children": [582, 583, 581] + "children": [ + 602, + 603, + 601 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 41 } ] @@ -26478,7 +28013,7 @@ } }, { - "id": 584, + "id": 604, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -26486,21 +28021,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 607, "name": "email", "kind": 1024, "kindString": "Property", @@ -26511,7 +28046,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 556, + "line": 582, "character": 2 } ], @@ -26521,7 +28056,7 @@ } }, { - "id": 588, + "id": 608, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -26532,7 +28067,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 560, + "line": 586, "character": 2 } ], @@ -26542,7 +28077,7 @@ } }, { - "id": 589, + "id": 609, "name": "options", "kind": 1024, "kindString": "Property", @@ -26552,7 +28087,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 587, "character": 2 } ], @@ -26561,7 +28096,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -26575,7 +28110,7 @@ } }, { - "id": 586, + "id": 606, "name": "type", "kind": 1024, "kindString": "Property", @@ -26583,7 +28118,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 554, + "line": 580, "character": 2 } ], @@ -26606,13 +28141,18 @@ { "title": "Properties", "kind": 1024, - "children": [587, 588, 589, 586] + "children": [ + 607, + 608, + 609, + 606 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 44 } ] @@ -26623,7 +28163,7 @@ } }, { - "id": 607, + "id": 627, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", @@ -26634,21 +28174,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 598, + "line": 624, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 608, + "id": 628, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, + "id": 629, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -26659,7 +28199,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 603, + "line": 629, "character": 2 } ], @@ -26669,7 +28209,7 @@ } }, { - "id": 610, + "id": 630, "name": "email_otp", "kind": 1024, "kindString": "Property", @@ -26680,7 +28220,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 608, + "line": 634, "character": 2 } ], @@ -26690,7 +28230,7 @@ } }, { - "id": 611, + "id": 631, "name": "hashed_token", "kind": 1024, "kindString": "Property", @@ -26701,7 +28241,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 612, + "line": 638, "character": 2 } ], @@ -26711,7 +28251,7 @@ } }, { - "id": 612, + "id": 632, "name": "redirect_to", "kind": 1024, "kindString": "Property", @@ -26722,7 +28262,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 614, + "line": 640, "character": 2 } ], @@ -26732,7 +28272,7 @@ } }, { - "id": 613, + "id": 633, "name": "verification_type", "kind": 1024, "kindString": "Property", @@ -26743,16 +28283,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 616, + "line": 642, "character": 2 } ], "type": { "type": "reference", - "id": 614, + "id": 634, "name": "GenerateLinkType", "dereferenced": { - "id": 614, + "id": 634, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -26760,7 +28300,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 619, + "line": 645, "character": 12 } ], @@ -26801,13 +28341,19 @@ { "title": "Properties", "kind": 1024, - "children": [609, 610, 611, 612, 613] + "children": [ + 629, + 630, + 631, + 632, + 633 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 598, + "line": 624, "character": 37 } ] @@ -26815,7 +28361,7 @@ } }, { - "id": 594, + "id": 614, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -26823,7 +28369,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 607, "character": 12 } ], @@ -26833,14 +28379,14 @@ { "type": "reflection", "declaration": { - "id": 595, + "id": 615, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 596, + "id": 616, "name": "data", "kind": 1024, "kindString": "Property", @@ -26848,21 +28394,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 609, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 597, + "id": 617, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 598, + "id": 618, "name": "properties", "kind": 1024, "kindString": "Property", @@ -26870,18 +28416,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 584, + "line": 610, "character": 8 } ], "type": { "type": "reference", - "id": 607, + "id": 627, "name": "GenerateLinkProperties" } }, { - "id": 599, + "id": 619, "name": "user", "kind": 1024, "kindString": "Property", @@ -26889,13 +28435,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 585, + "line": 611, "character": 8 } ], "type": { "type": "reference", - "id": 420, + "id": 425, "name": "User" } } @@ -26904,13 +28450,16 @@ { "title": "Properties", "kind": 1024, - "children": [598, 599] + "children": [ + 618, + 619 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 609, "character": 12 } ] @@ -26918,7 +28467,7 @@ } }, { - "id": 600, + "id": 620, "name": "error", "kind": 1024, "kindString": "Property", @@ -26926,7 +28475,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 587, + "line": 613, "character": 6 } ], @@ -26940,13 +28489,16 @@ { "title": "Properties", "kind": 1024, - "children": [596, 600] + "children": [ + 616, + 620 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 582, + "line": 608, "character": 4 } ] @@ -26955,14 +28507,14 @@ { "type": "reflection", "declaration": { - "id": 601, + "id": 621, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 602, + "id": 622, "name": "data", "kind": 1024, "kindString": "Property", @@ -26970,21 +28522,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 616, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 603, + "id": 623, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 604, + "id": 624, "name": "properties", "kind": 1024, "kindString": "Property", @@ -26992,7 +28544,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 591, + "line": 617, "character": 8 } ], @@ -27002,7 +28554,7 @@ } }, { - "id": 605, + "id": 625, "name": "user", "kind": 1024, "kindString": "Property", @@ -27010,7 +28562,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 592, + "line": 618, "character": 8 } ], @@ -27024,13 +28576,16 @@ { "title": "Properties", "kind": 1024, - "children": [604, 605] + "children": [ + 624, + 625 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 616, "character": 12 } ] @@ -27038,7 +28593,7 @@ } }, { - "id": 606, + "id": 626, "name": "error", "kind": 1024, "kindString": "Property", @@ -27046,13 +28601,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 594, + "line": 620, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -27061,13 +28616,16 @@ { "title": "Properties", "kind": 1024, - "children": [602, 606] + "children": [ + 622, + 626 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 589, + "line": 615, "character": 4 } ] @@ -27077,7 +28635,7 @@ } }, { - "id": 614, + "id": 634, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -27085,7 +28643,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 619, + "line": 645, "character": 12 } ], @@ -27120,7 +28678,7 @@ } }, { - "id": 579, + "id": 599, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -27128,21 +28686,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 602, "name": "email", "kind": 1024, "kindString": "Property", @@ -27153,7 +28711,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 575, "character": 2 } ], @@ -27163,7 +28721,7 @@ } }, { - "id": 583, + "id": 603, "name": "options", "kind": 1024, "kindString": "Property", @@ -27173,7 +28731,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 550, + "line": 576, "character": 2 } ], @@ -27182,7 +28740,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -27196,7 +28754,7 @@ } }, { - "id": 581, + "id": 601, "name": "type", "kind": 1024, "kindString": "Property", @@ -27204,7 +28762,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 547, + "line": 573, "character": 2 } ], @@ -27218,13 +28776,17 @@ { "title": "Properties", "kind": 1024, - "children": [582, 583, 581] + "children": [ + 602, + 603, + 601 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 41 } ] @@ -27232,7 +28794,7 @@ } }, { - "id": 568, + "id": 588, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -27240,21 +28802,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 589, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 571, + "id": 591, "name": "email", "kind": 1024, "kindString": "Property", @@ -27262,7 +28824,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 534, + "line": 560, "character": 2 } ], @@ -27272,7 +28834,7 @@ } }, { - "id": 573, + "id": 593, "name": "options", "kind": 1024, "kindString": "Property", @@ -27282,7 +28844,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 536, + "line": 562, "character": 2 } ], @@ -27291,7 +28853,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -27314,7 +28876,7 @@ } }, { - "id": 572, + "id": 592, "name": "password", "kind": 1024, "kindString": "Property", @@ -27322,7 +28884,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 535, + "line": 561, "character": 2 } ], @@ -27332,7 +28894,7 @@ } }, { - "id": 570, + "id": 590, "name": "type", "kind": 1024, "kindString": "Property", @@ -27340,7 +28902,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 533, + "line": 559, "character": 2 } ], @@ -27354,13 +28916,18 @@ { "title": "Properties", "kind": 1024, - "children": [571, 573, 572, 570] + "children": [ + 591, + 593, + 592, + 590 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 39 } ] @@ -27368,7 +28935,7 @@ } }, { - "id": 323, + "id": 328, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -27376,21 +28943,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 35, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 332, + "id": 337, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -27400,7 +28967,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 44, + "line": 45, "character": 2 } ], @@ -27410,7 +28977,7 @@ } }, { - "id": 331, + "id": 336, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -27420,7 +28987,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 42, + "line": 43, "character": 2 } ], @@ -27430,7 +28997,7 @@ } }, { - "id": 335, + "id": 340, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -27440,7 +29007,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 50, + "line": 51, "character": 2 } ], @@ -27450,7 +29017,7 @@ } }, { - "id": 336, + "id": 341, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -27460,16 +29027,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 52, + "line": 53, "character": 2 } ], "type": { "type": "reference", - "id": 515, + "id": 522, "name": "AuthFlowType", "dereferenced": { - "id": 515, + "id": 522, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -27477,7 +29044,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 439, + "line": 447, "character": 12 } ], @@ -27498,7 +29065,7 @@ } }, { - "id": 326, + "id": 331, "name": "headers", "kind": 1024, "kindString": "Property", @@ -27508,14 +29075,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 327, + "id": 332, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -27523,19 +29090,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 12 } ], "indexSignature": { - "id": 328, + "id": 333, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 329, + "id": 334, "name": "key", "kind": 32768, "flags": {}, @@ -27554,7 +29121,7 @@ } }, { - "id": 333, + "id": 338, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -27564,7 +29131,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 47, "character": 2 } ], @@ -27574,7 +29141,7 @@ } }, { - "id": 334, + "id": 339, "name": "storage", "kind": 1024, "kindString": "Property", @@ -27584,16 +29151,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 49, "character": 2 } ], "type": { "type": "reference", - "id": 756, + "id": 776, "name": "SupportedStorage", "dereferenced": { - "id": 756, + "id": 776, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -27601,7 +29168,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 929, + "line": 955, "character": 12 } ], @@ -27646,7 +29213,7 @@ } }, { - "id": 330, + "id": 335, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -27656,7 +29223,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 40, + "line": 41, "character": 2 } ], @@ -27666,7 +29233,7 @@ } }, { - "id": 325, + "id": 330, "name": "url", "kind": 1024, "kindString": "Property", @@ -27676,7 +29243,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 36, + "line": 37, "character": 2 } ], @@ -27690,13 +29257,23 @@ { "title": "Properties", "kind": 1024, - "children": [332, 331, 335, 336, 326, 333, 334, 330, 325] + "children": [ + 337, + 336, + 340, + 341, + 331, + 338, + 339, + 335, + 330 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 35, "character": 34 } ] @@ -27704,7 +29281,7 @@ } }, { - "id": 757, + "id": 777, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -27712,21 +29289,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 931, + "line": 957, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 758, + "id": 778, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 759, + "id": 779, "name": "error", "kind": 1024, "kindString": "Property", @@ -27734,7 +29311,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 931, + "line": 957, "character": 33 } ], @@ -27743,7 +29320,7 @@ "types": [ { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" }, { @@ -27758,13 +29335,15 @@ { "title": "Properties", "kind": 1024, - "children": [759] + "children": [ + 779 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 931, + "line": 957, "character": 31 } ] @@ -27772,7 +29351,7 @@ } }, { - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -27780,21 +29359,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 634, + "id": 654, "name": "code", "kind": 1024, "kindString": "Property", @@ -27805,7 +29384,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 661, + "line": 687, "character": 2 } ], @@ -27815,7 +29394,7 @@ } }, { - "id": 633, + "id": 653, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -27826,7 +29405,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 685, "character": 2 } ], @@ -27840,13 +29419,16 @@ { "title": "Properties", "kind": 1024, - "children": [634, 633] + "children": [ + 654, + 653 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 42 } ] @@ -27854,7 +29436,7 @@ } }, { - "id": 628, + "id": 648, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -27862,21 +29444,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 630, + "id": 650, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -27887,7 +29469,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 680, "character": 2 } ], @@ -27901,13 +29483,15 @@ { "title": "Properties", "kind": 1024, - "children": [630] + "children": [ + 650 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 33 } ] @@ -27915,7 +29499,7 @@ } }, { - "id": 615, + "id": 635, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -27923,21 +29507,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 636, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 637, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -27948,7 +29532,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 629, + "line": 655, "character": 2 } ], @@ -27958,7 +29542,7 @@ } }, { - "id": 619, + "id": 639, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -27971,7 +29555,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 633, + "line": 659, "character": 2 } ], @@ -27981,7 +29565,7 @@ } }, { - "id": 618, + "id": 638, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -27994,7 +29578,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 631, + "line": 657, "character": 2 } ], @@ -28008,13 +29592,17 @@ { "title": "Properties", "kind": 1024, - "children": [617, 619, 618] + "children": [ + 637, + 639, + 638 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 30 } ] @@ -28022,7 +29610,7 @@ } }, { - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -28030,21 +29618,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 621, + "id": 641, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 642, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -28055,7 +29643,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 638, + "line": 664, "character": 2 } ], @@ -28069,13 +29657,15 @@ { "title": "Properties", "kind": 1024, - "children": [622] + "children": [ + 642 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 32 } ] @@ -28083,7 +29673,7 @@ } }, { - "id": 623, + "id": 643, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -28091,21 +29681,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 644, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 646, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -28116,7 +29706,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 672, "character": 2 } ], @@ -28126,7 +29716,7 @@ } }, { - "id": 627, + "id": 647, "name": "code", "kind": 1024, "kindString": "Property", @@ -28137,7 +29727,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 675, "character": 2 } ], @@ -28147,7 +29737,7 @@ } }, { - "id": 625, + "id": 645, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -28158,7 +29748,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 669, "character": 2 } ], @@ -28172,13 +29762,17 @@ { "title": "Properties", "kind": 1024, - "children": [626, 627, 625] + "children": [ + 646, + 647, + 645 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 30 } ] @@ -28186,7 +29780,7 @@ } }, { - "id": 553, + "id": 560, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -28194,7 +29788,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 513, "character": 12 } ], @@ -28213,7 +29807,7 @@ } }, { - "id": 350, + "id": 355, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -28221,7 +29815,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 71, + "line": 72, "character": 12 } ], @@ -28231,14 +29825,14 @@ { "type": "reflection", "declaration": { - "id": 351, + "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 352, + "id": 357, "name": "data", "kind": 1024, "kindString": "Property", @@ -28246,21 +29840,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 74, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 353, + "id": 358, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 359, "name": "provider", "kind": 1024, "kindString": "Property", @@ -28268,18 +29862,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 75, "character": 8 } ], "type": { "type": "reference", - "id": 320, + "id": 325, "name": "Provider" } }, { - "id": 355, + "id": 360, "name": "url", "kind": 1024, "kindString": "Property", @@ -28287,7 +29881,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 75, + "line": 76, "character": 8 } ], @@ -28301,13 +29895,16 @@ { "title": "Properties", "kind": 1024, - "children": [354, 355] + "children": [ + 359, + 360 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 74, "character": 12 } ] @@ -28315,7 +29912,7 @@ } }, { - "id": 356, + "id": 361, "name": "error", "kind": 1024, "kindString": "Property", @@ -28323,7 +29920,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 78, "character": 6 } ], @@ -28337,13 +29934,16 @@ { "title": "Properties", "kind": 1024, - "children": [352, 356] + "children": [ + 357, + 361 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 73, "character": 4 } ] @@ -28352,14 +29952,14 @@ { "type": "reflection", "declaration": { - "id": 357, + "id": 362, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 358, + "id": 363, "name": "data", "kind": 1024, "kindString": "Property", @@ -28367,21 +29967,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, + "line": 81, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 359, + "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 360, + "id": 365, "name": "provider", "kind": 1024, "kindString": "Property", @@ -28389,18 +29989,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 81, + "line": 82, "character": 8 } ], "type": { "type": "reference", - "id": 320, + "id": 325, "name": "Provider" } }, { - "id": 361, + "id": 366, "name": "url", "kind": 1024, "kindString": "Property", @@ -28408,7 +30008,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 83, "character": 8 } ], @@ -28422,13 +30022,16 @@ { "title": "Properties", "kind": 1024, - "children": [360, 361] + "children": [ + 365, + 366 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, + "line": 81, "character": 12 } ] @@ -28436,7 +30039,7 @@ } }, { - "id": 362, + "id": 367, "name": "error", "kind": 1024, "kindString": "Property", @@ -28444,13 +30047,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 84, + "line": 85, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -28459,13 +30062,16 @@ { "title": "Properties", "kind": 1024, - "children": [358, 362] + "children": [ + 363, + 367 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, + "line": 80, "character": 4 } ] @@ -28475,7 +30081,7 @@ } }, { - "id": 774, + "id": 794, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -28483,21 +30089,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 775, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 796, "name": "page", "kind": 1024, "kindString": "Property", @@ -28510,7 +30116,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 952, + "line": 978, "character": 2 } ], @@ -28520,7 +30126,7 @@ } }, { - "id": 777, + "id": 797, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -28533,7 +30139,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 954, + "line": 980, "character": 2 } ], @@ -28547,13 +30153,16 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777] + "children": [ + 796, + 797 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 25 } ] @@ -28561,7 +30170,7 @@ } }, { - "id": 767, + "id": 787, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -28569,21 +30178,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 943, + "line": 969, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 770, + "id": 790, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -28591,7 +30200,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 946, + "line": 972, "character": 2 } ], @@ -28601,7 +30210,7 @@ } }, { - "id": 769, + "id": 789, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -28609,7 +30218,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 945, + "line": 971, "character": 2 } ], @@ -28628,7 +30237,7 @@ } }, { - "id": 771, + "id": 791, "name": "total", "kind": 1024, "kindString": "Property", @@ -28636,7 +30245,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 947, + "line": 973, "character": 2 } ], @@ -28650,25 +30259,29 @@ { "title": "Properties", "kind": 1024, - "children": [770, 769, 771] + "children": [ + 790, + 789, + 791 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 943, + "line": 969, "character": 25 } ], "indexSignature": { - "id": 772, + "id": 792, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 773, + "id": 793, "name": "key", "kind": 32768, "flags": {}, @@ -28687,7 +30300,7 @@ } }, { - "id": 320, + "id": 325, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -28768,20 +30381,24 @@ { "type": "literal", "value": "workos" + }, + { + "type": "literal", + "value": "zoom" } ] } }, { - "id": 363, - "name": "SSOResponse", + "id": 562, + "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 87, + "line": 516, "character": 12 } ], @@ -28791,48 +30408,69 @@ { "type": "reflection", "declaration": { - "id": 364, + "id": 563, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, - "name": "data", + "id": 565, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, + "line": 519, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 566, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 366, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 367, - "name": "url", + "id": 568, + "name": "captchaToken", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "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" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 522, "character": 8 } ], @@ -28846,35 +30484,59 @@ { "title": "Properties", "kind": 1024, - "children": [367] + "children": [ + 568 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, - "character": 12 + "line": 520, + "character": 16 } ] } } }, { - "id": 368, - "name": "error", + "id": 564, + "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 99, + "line": 518, "character": 6 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 561, + "name": "EmailOtpType" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "signup" + }, + { + "type": "literal", + "value": "email_change" + } + ] + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" } } ], @@ -28882,18 +30544,196 @@ { "title": "Properties", "kind": 1024, - "children": [365, 368] + "children": [ + 565, + 566, + 564 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, + "line": 517, "character": 4 } ] } }, + { + "type": "reflection", + "declaration": { + "id": 569, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 572, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 573, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 574, + "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": 530, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 574 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 16 + } + ] + } + } + }, + { + "id": 571, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 527, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 570, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 526, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 560, + "name": "MobileOtpType" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "phone" + } + ] + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 572, + 571, + 570 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 525, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 368, + "name": "SSOResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ { "type": "reflection", "declaration": { @@ -28912,7 +30752,71 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 102, + "line": 90, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 371, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 372, + "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": 98, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 372 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 12 + } + ] + } + } + }, + { + "id": 373, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, "character": 6 } ], @@ -28920,10 +30824,39 @@ "type": "literal", "value": null } - }, + } + ], + "groups": [ { - "id": 371, - "name": "error", + "title": "Properties", + "kind": 1024, + "children": [ + 370, + 373 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 89, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 374, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 375, + "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, @@ -28934,9 +30867,27 @@ "character": 6 } ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 376, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 6 + } + ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -28945,13 +30896,16 @@ { "title": "Properties", "kind": 1024, - "children": [370, 371] + "children": [ + 375, + 376 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 101, + "line": 102, "character": 4 } ] @@ -28961,7 +30915,7 @@ } }, { - "id": 528, + "id": 535, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -28969,21 +30923,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 463, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 529, + "id": 536, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 532, + "id": 539, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -28996,7 +30950,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 463, + "line": 471, "character": 2 } ], @@ -29006,7 +30960,7 @@ } }, { - "id": 533, + "id": 540, "name": "options", "kind": 1024, "kindString": "Property", @@ -29016,21 +30970,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 472, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 534, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 535, + "id": 542, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -29043,7 +30997,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 466, + "line": 474, "character": 4 } ], @@ -29057,13 +31011,15 @@ { "title": "Properties", "kind": 1024, - "children": [535] + "children": [ + 542 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 472, "character": 12 } ] @@ -29071,7 +31027,7 @@ } }, { - "id": 530, + "id": 537, "name": "provider", "kind": 1024, "kindString": "Property", @@ -29082,7 +31038,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 459, + "line": 467, "character": 2 } ], @@ -29101,7 +31057,7 @@ } }, { - "id": 531, + "id": 538, "name": "token", "kind": 1024, "kindString": "Property", @@ -29112,7 +31068,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 461, + "line": 469, "character": 2 } ], @@ -29126,13 +31082,18 @@ { "title": "Properties", "kind": 1024, - "children": [532, 533, 530, 531] + "children": [ + 539, + 540, + 537, + 538 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 463, "character": 43 } ] @@ -29140,7 +31101,7 @@ } }, { - "id": 516, + "id": 523, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -29148,21 +31109,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 448, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 517, + "id": 524, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 526, "name": "options", "kind": 1024, "kindString": "Property", @@ -29172,21 +31133,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 443, + "line": 451, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 520, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 523, + "id": 530, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -29199,14 +31160,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 449, + "line": 457, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 524, + "id": 531, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -29214,19 +31175,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 449, + "line": 457, "character": 18 } ], "indexSignature": { - "id": 525, + "id": 532, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 526, + "id": 533, "name": "key", "kind": 32768, "flags": {}, @@ -29245,7 +31206,7 @@ } }, { - "id": 521, + "id": 528, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -29258,7 +31219,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 445, + "line": 453, "character": 4 } ], @@ -29268,7 +31229,7 @@ } }, { - "id": 522, + "id": 529, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -29281,7 +31242,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 447, + "line": 455, "character": 4 } ], @@ -29291,7 +31252,7 @@ } }, { - "id": 527, + "id": 534, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -29304,7 +31265,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 451, + "line": 459, "character": 4 } ], @@ -29318,13 +31279,18 @@ { "title": "Properties", "kind": 1024, - "children": [523, 521, 522, 527] + "children": [ + 530, + 528, + 529, + 534 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 443, + "line": 451, "character": 12 } ] @@ -29332,7 +31298,7 @@ } }, { - "id": 518, + "id": 525, "name": "provider", "kind": 1024, "kindString": "Property", @@ -29343,16 +31309,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 442, + "line": 450, "character": 2 } ], "type": { "type": "reference", - "id": 320, + "id": 325, "name": "Provider", "dereferenced": { - "id": 320, + "id": 325, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -29433,6 +31399,10 @@ { "type": "literal", "value": "workos" + }, + { + "type": "literal", + "value": "zoom" } ] } @@ -29444,13 +31414,16 @@ { "title": "Properties", "kind": 1024, - "children": [519, 518] + "children": [ + 526, + 525 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 448, "character": 41 } ] @@ -29458,7 +31431,7 @@ } }, { - "id": 484, + "id": 491, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -29466,7 +31439,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 373, + "line": 381, "character": 12 } ], @@ -29476,14 +31449,14 @@ { "type": "reflection", "declaration": { - "id": 485, + "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 486, + "id": 493, "name": "email", "kind": 1024, "kindString": "Property", @@ -29494,7 +31467,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 376, + "line": 384, "character": 6 } ], @@ -29504,7 +31477,7 @@ } }, { - "id": 488, + "id": 495, "name": "options", "kind": 1024, "kindString": "Property", @@ -29514,126 +31487,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 379, + "line": 387, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 489, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 490, - "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": 381, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [490] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 379, - "character": 16 - } - ] - } - } - }, - { - "id": 487, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 378, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [486, 488, 487] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 374, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 491, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 494, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 389, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 495, + "id": 496, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -29653,7 +31514,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 397, + "line": 389, "character": 8 } ], @@ -29661,43 +31522,21 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 496, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 395, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [497, 496] + "children": [ + 497 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 389, + "line": 387, "character": 16 } ] @@ -29705,7 +31544,7 @@ } }, { - "id": 493, + "id": 494, "name": "password", "kind": 1024, "kindString": "Property", @@ -29713,27 +31552,6 @@ "comment": { "shortText": "The user's password." }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 388, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 492, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -29751,67 +31569,31 @@ { "title": "Properties", "kind": 1024, - "children": [494, 493, 492] + "children": [ + 493, + 495, + 494 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 384, + "line": 382, "character": 4 } ] } - } - ] - } - }, - { - "id": 498, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 401, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ + }, { "type": "reflection", "declaration": { - "id": 499, + "id": 498, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ - { - "id": 500, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 501, "name": "options", @@ -29823,7 +31605,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 397, "character": 6 } ], @@ -29837,7 +31619,7 @@ "flags": {}, "children": [ { - "id": 506, + "id": 504, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -29850,7 +31632,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 417, + "line": 405, "character": 8 } ], @@ -29860,7 +31642,7 @@ } }, { - "id": 505, + "id": 503, "name": "data", "kind": 1024, "kindString": "Property", @@ -29874,7 +31656,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 415, + "line": 403, "character": 8 } ], @@ -29882,99 +31664,142 @@ "type": "intrinsic", "name": "object" } - }, - { - "id": 503, - "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": 407, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 504, - "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": 409, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [506, 505, 503, 504] + "children": [ + 504, + 503 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 397, "character": 16 } ] } } + }, + { + "id": 500, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 396, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 499, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 394, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [500, 501] + "children": [ + 501, + 500, + 499 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 402, + "line": 392, "character": 4 } ] } - }, + } + ] + } + }, + { + "id": 505, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 409, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ { "type": "reflection", "declaration": { - "id": 507, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 509, + "id": 507, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 412, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 508, "name": "options", "kind": 1024, "kindString": "Property", @@ -29984,14 +31809,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 423, + "line": 413, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 510, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -30011,7 +31836,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 425, "character": 8 } ], @@ -30020,38 +31845,6 @@ "name": "string" } }, - { - "id": 514, - "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": 435, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, { "id": 512, "name": "data", @@ -30067,7 +31860,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 431, + "line": 423, "character": 8 } ], @@ -30076,6 +31869,29 @@ "name": "object" } }, + { + "id": 510, + "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": 415, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, { "id": 511, "name": "shouldCreateUser", @@ -30090,7 +31906,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 425, + "line": 417, "character": 8 } ], @@ -30104,206 +31920,39 @@ { "title": "Properties", "kind": 1024, - "children": [513, 514, 512, 511] + "children": [ + 513, + 512, + 510, + 511 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 423, + "line": 413, "character": 16 } ] } } - }, - { - "id": 508, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 422, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [509, 508] + "children": [ + 507, + 508 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 420, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 555, - "name": "SignInWithSSO", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 508, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 558, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 513, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 559, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 561, - "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": 517, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 560, - "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": 515, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [561, 560] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 513, - "character": 16 - } - ] - } - } - }, - { - "id": 557, - "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": 511, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [558, 557] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 509, + "line": 410, "character": 4 } ] @@ -30312,35 +31961,14 @@ { "type": "reflection", "declaration": { - "id": 562, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 563, - "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": 522, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 564, + "id": 516, "name": "options", "kind": 1024, "kindString": "Property", @@ -30350,21 +31978,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 524, + "line": 431, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 565, + "id": 517, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 567, + "id": 520, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30377,7 +32005,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 528, + "line": 441, "character": 8 } ], @@ -30387,320 +32015,7 @@ } }, { - "id": 566, - "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": 526, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [567, 566] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 524, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [563, 564] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 467, - "name": "SignUpWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 336, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 469, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 471, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 472, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 475, - "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": 352, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 474, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 473, - "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": 344, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [475, 474, 473] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 16 - } - ] - } - } - }, - { - "id": 470, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [469, 471, 470] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 476, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 479, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 360, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 482, - "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": 368, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 483, + "id": 521, "name": "channel", "kind": 1024, "kindString": "Property", @@ -30713,7 +32028,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 370, + "line": 443, "character": 8 } ], @@ -30731,6 +32046,514 @@ ] } }, + { + "id": 519, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 439, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 518, + "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": 433, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 520, + 521, + 519, + 518 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 431, + "character": 16 + } + ] + } + } + }, + { + "id": 515, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 430, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 516, + 515 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 428, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 575, + "name": "SignInWithSSO", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 534, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 576, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 578, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 539, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 579, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 581, + "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": 543, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 580, + "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": 541, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 581, + 580 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 539, + "character": 16 + } + ] + } + } + }, + { + "id": 577, + "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": 537, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 578, + 577 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 535, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 582, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 583, + "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": 548, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 584, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 550, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 585, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 587, + "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": 554, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 586, + "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": 552, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 587, + 586 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 550, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 583, + 584 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 546, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 474, + "name": "SignUpWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 475, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 476, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 478, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 350, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 479, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 482, + "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": 360, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, { "id": 481, "name": "data", @@ -30746,7 +32569,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 358, "character": 8 } ], @@ -30754,19 +32577,46 @@ "type": "intrinsic", "name": "object" } + }, + { + "id": 480, + "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": 352, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [482, 483, 481] + "children": [ + 482, + 481, + 480 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 360, + "line": 350, "character": 16 } ] @@ -30774,7 +32624,7 @@ } }, { - "id": 478, + "id": 477, "name": "password", "kind": 1024, "kindString": "Property", @@ -30785,28 +32635,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 477, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 357, + "line": 349, "character": 6 } ], @@ -30820,13 +32649,214 @@ { "title": "Properties", "kind": 1024, - "children": [479, 478, 477] + "children": [ + 476, + 478, + 477 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 355, + "line": 345, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 483, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 486, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 487, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 489, + "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": 376, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 490, + "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": 378, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 488, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 374, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 489, + 490, + 488 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 16 + } + ] + } + } + }, + { + "id": 485, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 367, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 484, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 365, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 486, + 485, + 484 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 363, "character": 4 } ] @@ -30836,7 +32866,7 @@ } }, { - "id": 756, + "id": 776, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -30844,7 +32874,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 929, + "line": 955, "character": 12 } ], @@ -30887,7 +32917,7 @@ } }, { - "id": 372, + "id": 377, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -30895,116 +32925,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 106, + "line": 107, "character": 12 } ], "type": { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 373, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 374, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 376, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 420, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [376] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 12 - } - ] - } - } - }, - { - "id": 377, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [374, 377] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 4 - } - ] - } - }, { "type": "reflection", "declaration": { @@ -31023,7 +32950,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 114, + "line": 109, "character": 6 } ], @@ -31045,13 +32972,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 115, + "line": 110, "character": 8 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 425, + "name": "User" } } ], @@ -31059,13 +32987,15 @@ { "title": "Properties", "kind": 1024, - "children": [381] + "children": [ + 381 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 114, + "line": 109, "character": 12 } ] @@ -31081,13 +33011,120 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 117, + "line": 112, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 379, + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 383, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 384, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 385, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 386, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 386 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 12 + } + ] + } + } + }, + { + "id": 387, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -31096,13 +33133,16 @@ { "title": "Properties", "kind": 1024, - "children": [379, 382] + "children": [ + 384, + 387 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, + "line": 114, "character": 4 } ] @@ -31112,7 +33152,7 @@ } }, { - "id": 536, + "id": 543, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -31120,7 +33160,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 470, + "line": 478, "character": 12 } ], @@ -31128,14 +33168,14 @@ "type": "union", "types": [ { - "id": 537, + "id": 544, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 541, + "id": 548, "name": "options", "kind": 1024, "kindString": "Property", @@ -31145,21 +33185,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 478, + "line": 486, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 542, + "id": 549, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 551, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -31178,7 +33218,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 495, "character": 4 } ], @@ -31188,7 +33228,7 @@ } }, { - "id": 543, + "id": 550, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -31201,7 +33241,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 480, + "line": 488, "character": 4 } ], @@ -31215,14 +33255,17 @@ { "title": "Properties", "kind": 1024, - "children": [544, 543] + "children": [ + 551, + 550 + ] } ] } } }, { - "id": 538, + "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", @@ -31233,7 +33276,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 473, + "line": 481, "character": 2 } ], @@ -31243,7 +33286,7 @@ } }, { - "id": 539, + "id": 546, "name": "token", "kind": 1024, "kindString": "Property", @@ -31254,7 +33297,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 475, + "line": 483, "character": 2 } ], @@ -31264,7 +33307,7 @@ } }, { - "id": 540, + "id": 547, "name": "type", "kind": 1024, "kindString": "Property", @@ -31275,16 +33318,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 477, + "line": 485, "character": 2 } ], "type": { "type": "reference", - "id": 553, + "id": 560, "name": "MobileOtpType", "dereferenced": { - "id": 553, + "id": 560, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -31292,7 +33335,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 513, "character": 12 } ], @@ -31317,26 +33360,31 @@ { "title": "Properties", "kind": 1024, - "children": [541, 538, 539, 540] + "children": [ + 548, + 545, + 546, + 547 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 479, "character": 17 } ] }, { - "id": 545, + "id": 552, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 546, + "id": 553, "name": "email", "kind": 1024, "kindString": "Property", @@ -31347,7 +33395,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 492, + "line": 500, "character": 2 } ], @@ -31357,7 +33405,7 @@ } }, { - "id": 549, + "id": 556, "name": "options", "kind": 1024, "kindString": "Property", @@ -31367,21 +33415,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 497, + "line": 505, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 550, + "id": 557, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 559, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -31394,7 +33442,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 501, + "line": 509, "character": 4 } ], @@ -31404,7 +33452,7 @@ } }, { - "id": 551, + "id": 558, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -31417,7 +33465,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 499, + "line": 507, "character": 4 } ], @@ -31431,14 +33479,17 @@ { "title": "Properties", "kind": 1024, - "children": [552, 551] + "children": [ + 559, + 558 + ] } ] } } }, { - "id": 547, + "id": 554, "name": "token", "kind": 1024, "kindString": "Property", @@ -31449,7 +33500,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 494, + "line": 502, "character": 2 } ], @@ -31459,7 +33510,7 @@ } }, { - "id": 548, + "id": 555, "name": "type", "kind": 1024, "kindString": "Property", @@ -31470,16 +33521,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 496, + "line": 504, "character": 2 } ], "type": { "type": "reference", - "id": 554, + "id": 561, "name": "EmailOtpType", "dereferenced": { - "id": 554, + "id": 561, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -31487,7 +33538,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 514, "character": 12 } ], @@ -31528,13 +33579,18 @@ { "title": "Properties", "kind": 1024, - "children": [546, 549, 547, 548] + "children": [ + 553, + 556, + 554, + 555 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 490, + "line": 498, "character": 17 } ] @@ -31543,7 +33599,7 @@ } }, { - "id": 781, + "id": 801, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -31557,14 +33613,14 @@ ], "signatures": [ { - "id": 782, + "id": 802, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 783, + "id": 803, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -31581,7 +33637,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 791, + "id": 811, "name": "AuthApiError" } } @@ -31589,7 +33645,7 @@ ] }, { - "id": 778, + "id": 798, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -31603,14 +33659,14 @@ ], "signatures": [ { - "id": 779, + "id": 799, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 780, + "id": 800, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -31627,7 +33683,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -31639,28 +33695,103 @@ { "title": "Classes", "kind": 128, - "children": [791, 784, 852, 839, 877, 902, 827, 804, 812, 1, 77] + "children": [ + 811, + 804, + 872, + 859, + 897, + 922, + 847, + 824, + 832, + 1, + 77 + ] }, { "title": "Interfaces", "kind": 256, "children": [ - 392, 448, 406, 590, 749, 704, 383, 457, 465, 420, 413, 443, 395, 417, 545, 537 + 397, + 454, + 411, + 610, + 769, + 724, + 388, + 464, + 472, + 425, + 418, + 448, + 400, + 422, + 552, + 544 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 322, 321, 515, 733, 724, 746, 737, 672, 648, 693, 682, 663, 635, 337, 692, 760, 554, - 584, 574, 593, 607, 594, 614, 579, 568, 323, 757, 631, 628, 615, 620, 623, 553, 350, - 774, 767, 320, 363, 528, 516, 484, 498, 555, 467, 756, 372, 536 + 327, + 326, + 522, + 753, + 744, + 766, + 757, + 692, + 668, + 713, + 702, + 683, + 655, + 342, + 712, + 780, + 561, + 604, + 594, + 613, + 627, + 614, + 634, + 599, + 588, + 328, + 777, + 651, + 648, + 635, + 640, + 643, + 560, + 355, + 794, + 787, + 325, + 562, + 368, + 535, + 523, + 491, + 505, + 575, + 474, + 776, + 377, + 543 ] }, { "title": "Functions", "kind": 64, - "children": [781, 778] + "children": [ + 801, + 798 + ] } ], "sources": [ @@ -31748,17 +33879,32 @@ { "title": "Constructors", "kind": 512, - "children": [537] + "children": [ + 537 + ] }, { "title": "Properties", "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] }, { "title": "Methods", "kind": 2048, - "children": [556, 554] + "children": [ + 556, + 554 + ] } ], "sources": [ @@ -31825,26 +33971,6 @@ } ] }, - { - "id": 553, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, { "id": 545, "name": "body", @@ -31988,6 +34114,26 @@ "name": "Record" } }, + { + "id": 553, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 541, "name": "method", @@ -32402,17 +34548,32 @@ { "title": "Constructors", "kind": 512, - "children": [537] + "children": [ + 537 + ] }, { "title": "Properties", "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] }, { "title": "Methods", "kind": 2048, - "children": [556, 554] + "children": [ + 556, + 554 + ] } ], "sources": [ @@ -32794,7 +34955,11 @@ { "title": "Properties", "kind": 1024, - "children": [12, 10, 11] + "children": [ + 12, + 10, + 11 + ] } ] } @@ -33353,7 +35518,10 @@ { "title": "Properties", "kind": 1024, - "children": [45, 44] + "children": [ + 45, + 44 + ] } ] } @@ -33471,17 +35639,27 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [ + 2 + ] }, { "title": "Properties", "kind": 1024, - "children": [20, 18, 19, 17] + "children": [ + 20, + 18, + 19, + 17 + ] }, { "title": "Methods", "kind": 2048, - "children": [25, 36] + "children": [ + 25, + 36 + ] } ], "sources": [ @@ -33778,26 +35956,6 @@ } ] }, - { - "id": 553, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, { "id": 545, "name": "body", @@ -33941,6 +36099,26 @@ "name": "Record" } }, + { + "id": 553, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 541, "name": "method", @@ -34355,17 +36533,32 @@ { "title": "Constructors", "kind": 512, - "children": [537] + "children": [ + 537 + ] }, { "title": "Properties", "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] }, { "title": "Methods", "kind": 2048, - "children": [556, 554] + "children": [ + 556, + 554 + ] } ], "sources": [ @@ -34452,31 +36645,6 @@ "name": "default.constructor" } }, - { - "id": 419, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 518, - "name": "default.allowEmpty" - } - }, { "id": 411, "name": "body", @@ -34635,6 +36803,31 @@ "name": "default.headers" } }, + { + "id": 419, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 518, + "name": "default.isMaybeSingle" + } + }, { "id": 407, "name": "method", @@ -35313,7 +37506,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 166, "character": 2 } ], @@ -35526,7 +37719,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 194, + "line": 200, "character": 2 } ], @@ -35574,7 +37767,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 202, + "line": 208, "character": 4 } ], @@ -35597,7 +37790,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, + "line": 211, "character": 4 } ], @@ -35620,7 +37813,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, + "line": 213, "character": 4 } ], @@ -35652,7 +37845,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, + "line": 210, "character": 4 } ], @@ -35675,7 +37868,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, + "line": 209, "character": 4 } ], @@ -35698,7 +37891,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, + "line": 212, "character": 4 } ], @@ -35712,7 +37905,14 @@ { "title": "Properties", "kind": 1024, - "children": [396, 399, 401, 398, 397, 400] + "children": [ + 396, + 399, + 401, + 398, + 397, + 400 + ] } ] } @@ -36062,7 +38262,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 174, "character": 2 } ], @@ -37882,7 +40082,9 @@ { "title": "Properties", "kind": 1024, - "children": [371] + "children": [ + 371 + ] } ] } @@ -38943,7 +41145,9 @@ { "title": "Properties", "kind": 1024, - "children": [334] + "children": [ + 334 + ] } ] } @@ -39124,7 +41328,11 @@ { "title": "Properties", "kind": 1024, - "children": [356, 358, 357] + "children": [ + 356, + 358, + 357 + ] } ] } @@ -39276,7 +41484,11 @@ { "title": "Properties", "kind": 1024, - "children": [363, 365, 364] + "children": [ + 363, + 365, + 364 + ] } ] } @@ -39605,7 +41817,9 @@ { "title": "Properties", "kind": 1024, - "children": [378] + "children": [ + 378 + ] } ] } @@ -40432,7 +42646,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 246, + "line": 252, "character": 2 } ], @@ -40502,7 +42716,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 232, + "line": 238, "character": 2 } ], @@ -40911,7 +43125,10 @@ { "title": "Properties", "kind": 1024, - "children": [304, 305] + "children": [ + 304, + 305 + ] } ] } @@ -41063,7 +43280,10 @@ { "title": "Properties", "kind": 1024, - "children": [311, 312] + "children": [ + 311, + 312 + ] } ] } @@ -41403,20 +43623,70 @@ { "title": "Constructors", "kind": 512, - "children": [115] + "children": [ + 115 + ] }, { "title": "Properties", "kind": 1024, - "children": [419, 411, 414, 409, 407, 410, 412, 413, 408] + "children": [ + 411, + 414, + 409, + 419, + 407, + 410, + 412, + 413, + 408 + ] }, { "title": "Methods", "kind": 2048, "children": [ - 379, 241, 233, 388, 121, 392, 335, 390, 137, 145, 193, 201, 209, 225, 217, 169, 177, - 185, 366, 153, 161, 313, 385, 129, 319, 329, 350, 289, 372, 281, 249, 257, 265, 273, - 404, 402, 345, 382, 297, 422, 420 + 379, + 241, + 233, + 388, + 121, + 392, + 335, + 390, + 137, + 145, + 193, + 201, + 209, + 225, + 217, + 169, + 177, + 185, + 366, + 153, + 161, + 313, + 385, + 129, + 319, + 329, + 350, + 289, + 372, + 281, + 249, + 257, + 265, + 273, + 404, + 402, + 345, + 382, + 297, + 422, + 420 ] } ], @@ -41731,7 +44001,11 @@ { "title": "Properties", "kind": 1024, - "children": [59, 57, 58] + "children": [ + 59, + 57, + 58 + ] } ] } @@ -42025,7 +44299,9 @@ { "title": "Properties", "kind": 1024, - "children": [111] + "children": [ + 111 + ] } ] } @@ -42225,7 +44501,10 @@ { "title": "Properties", "kind": 1024, - "children": [88, 89] + "children": [ + 88, + 89 + ] } ] } @@ -42441,7 +44720,10 @@ { "title": "Properties", "kind": 1024, - "children": [81, 80] + "children": [ + 81, + 80 + ] } ] } @@ -42610,7 +44892,9 @@ { "title": "Properties", "kind": 1024, - "children": [106] + "children": [ + 106 + ] } ] } @@ -42856,7 +45140,12 @@ { "title": "Properties", "kind": 1024, - "children": [98, 99, 97, 96] + "children": [ + 98, + 99, + 97, + 96 + ] } ] } @@ -42900,17 +45189,31 @@ { "title": "Constructors", "kind": 512, - "children": [50] + "children": [ + 50 + ] }, { "title": "Properties", "kind": 1024, - "children": [68, 65, 66, 67, 64] + "children": [ + 68, + 65, + 66, + 67, + 64 + ] }, { "title": "Methods", "kind": 2048, - "children": [107, 82, 73, 100, 90] + "children": [ + 107, + 82, + 73, + 100, + 90 + ] } ], "sources": [ @@ -43110,26 +45413,6 @@ } ] }, - { - "id": 553, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, { "id": 545, "name": "body", @@ -43273,6 +45556,26 @@ "name": "Record" } }, + { + "id": 553, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 541, "name": "method", @@ -43687,17 +45990,32 @@ { "title": "Constructors", "kind": 512, - "children": [537] + "children": [ + 537 + ] }, { "title": "Properties", "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] }, { "title": "Methods", "kind": 2048, - "children": [556, 554] + "children": [ + 556, + 554 + ] } ], "sources": [ @@ -43784,31 +46102,6 @@ "name": "default.constructor" } }, - { - "id": 518, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 553, - "name": "default.allowEmpty" - } - }, { "id": 510, "name": "body", @@ -43967,6 +46260,31 @@ "name": "default.headers" } }, + { + "id": 518, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 553, + "name": "default.isMaybeSingle" + } + }, { "id": 506, "name": "method", @@ -44195,7 +46513,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 166, "character": 2 } ], @@ -44232,7 +46550,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 194, + "line": 200, "character": 2 } ], @@ -44280,7 +46598,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 202, + "line": 208, "character": 4 } ], @@ -44303,7 +46621,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, + "line": 211, "character": 4 } ], @@ -44326,7 +46644,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, + "line": 213, "character": 4 } ], @@ -44358,7 +46676,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, + "line": 210, "character": 4 } ], @@ -44381,7 +46699,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, + "line": 209, "character": 4 } ], @@ -44404,7 +46722,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, + "line": 212, "character": 4 } ], @@ -44418,7 +46736,14 @@ { "title": "Properties", "kind": 1024, - "children": [495, 498, 500, 497, 496, 499] + "children": [ + 495, + 498, + 500, + 497, + 496, + 499 + ] } ] } @@ -44480,7 +46805,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 174, "character": 2 } ], @@ -44605,7 +46930,9 @@ { "title": "Properties", "kind": 1024, - "children": [470] + "children": [ + 470 + ] } ] } @@ -44866,7 +47193,11 @@ { "title": "Properties", "kind": 1024, - "children": [455, 457, 456] + "children": [ + 455, + 457, + 456 + ] } ] } @@ -45013,7 +47344,11 @@ { "title": "Properties", "kind": 1024, - "children": [462, 464, 463] + "children": [ + 462, + 464, + 463 + ] } ] } @@ -45144,7 +47479,9 @@ { "title": "Properties", "kind": 1024, - "children": [477] + "children": [ + 477 + ] } ] } @@ -45186,7 +47523,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 246, + "line": 252, "character": 2 } ], @@ -45246,7 +47583,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 232, + "line": 238, "character": 2 } ], @@ -45782,17 +48119,44 @@ { "title": "Constructors", "kind": 512, - "children": [438] + "children": [ + 438 + ] }, { "title": "Properties", "kind": 1024, - "children": [518, 510, 513, 508, 506, 509, 511, 512, 507] + "children": [ + 510, + 513, + 508, + 518, + 506, + 509, + 511, + 512, + 507 + ] }, { "title": "Methods", "kind": 2048, - "children": [478, 487, 491, 489, 465, 484, 449, 471, 503, 501, 444, 481, 521, 519] + "children": [ + 478, + 487, + 491, + 489, + 465, + 484, + 449, + 471, + 503, + 501, + 444, + 481, + 521, + 519 + ] } ], "sources": [ @@ -46030,7 +48394,12 @@ { "title": "Properties", "kind": 1024, - "children": [593, 591, 592, 590] + "children": [ + 593, + 591, + 592, + 590 + ] } ], "sources": [ @@ -46094,7 +48463,13 @@ { "title": "Properties", "kind": 1024, - "children": [574, 573, 572, 575, 576] + "children": [ + 574, + 573, + 572, + 575, + 576 + ] } ], "sources": [ @@ -46232,7 +48607,13 @@ { "title": "Properties", "kind": 1024, - "children": [580, 579, 578, 581, 582] + "children": [ + 580, + 579, + 578, + 581, + 582 + ] } ], "sources": [ @@ -46361,7 +48742,12 @@ { "title": "Properties", "kind": 1024, - "children": [593, 591, 592, 590] + "children": [ + 593, + 591, + 592, + 590 + ] } ], "sources": [ @@ -46602,7 +48988,13 @@ { "title": "Properties", "kind": 1024, - "children": [580, 579, 578, 581, 582] + "children": [ + 580, + 579, + 578, + 581, + 582 + ] } ], "sources": [ @@ -46791,7 +49183,12 @@ { "title": "Properties", "kind": 1024, - "children": [593, 591, 592, 590] + "children": [ + 593, + 591, + 592, + 590 + ] } ], "sources": [ @@ -46855,7 +49252,13 @@ { "title": "Properties", "kind": 1024, - "children": [574, 573, 572, 575, 576] + "children": [ + 574, + 573, + 572, + 575, + 576 + ] } ], "sources": [ @@ -46880,17 +49283,31 @@ { "title": "Classes", "kind": 128, - "children": [536, 1, 114, 49, 437] + "children": [ + 536, + 1, + 114, + 49, + 437 + ] }, { "title": "Interfaces", "kind": 256, - "children": [571, 577] + "children": [ + 571, + 577 + ] }, { "title": "Type Aliases", "kind": 4194304, - "children": [588, 586, 569, 584] + "children": [ + 588, + 586, + 569, + 584 + ] } ], "sources": [ @@ -46981,7 +49398,11 @@ { "title": "Enumeration Members", "kind": 16, - "children": [536, 538, 537] + "children": [ + 536, + 538, + 537 + ] } ], "sources": [ @@ -47080,7 +49501,12 @@ { "title": "Enumeration Members", "kind": 16, - "children": [540, 543, 541, 542] + "children": [ + 540, + 543, + 541, + 542 + ] } ], "sources": [ @@ -47160,7 +49586,11 @@ { "title": "Enumeration Members", "kind": 16, - "children": [546, 547, 545] + "children": [ + 546, + 547, + 545 + ] } ], "sources": [ @@ -47259,7 +49689,12 @@ { "title": "Enumeration Members", "kind": 16, - "children": [552, 551, 549, 550] + "children": [ + 552, + 551, + 549, + 550 + ] } ], "sources": [ @@ -47438,7 +49873,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -47503,7 +49941,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -47521,7 +49961,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -47539,7 +49982,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -47912,7 +50357,15 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, 443, 442 + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 ] } ], @@ -48532,7 +50985,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -48735,7 +51193,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -48800,7 +51261,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -48818,7 +51281,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -48836,7 +51302,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -49271,7 +51739,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -49396,19 +51870,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99 + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -49498,20 +51993,54 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, - 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] } ], "sources": [ @@ -49700,7 +52229,12 @@ { "title": "Properties", "kind": 1024, - "children": [90, 86, 91, 85] + "children": [ + 90, + 86, + 91, + 85 + ] } ], "sources": [ @@ -49883,7 +52417,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -49948,7 +52485,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -49966,7 +52505,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -49984,7 +52526,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -50075,17 +52619,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -50219,12 +52786,17 @@ { "title": "Properties", "kind": 1024, - "children": [46, 47] + "children": [ + 46, + 47 + ] }, { "title": "Methods", "kind": 2048, - "children": [48] + "children": [ + 48 + ] } ] } @@ -50257,17 +52829,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -50497,12 +53092,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -50913,7 +53516,17 @@ { "title": "Properties", "kind": 1024, - "children": [447, 446, 449, 444, 445, 453, 448, 443, 442] + "children": [ + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 + ] } ], "sources": [ @@ -51532,7 +54145,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -51735,7 +54353,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -51800,7 +54421,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -51818,7 +54441,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -51836,7 +54462,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -52271,7 +54899,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -52396,17 +55030,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -52496,20 +55153,54 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, 348, 354, - 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] } ], "sources": [ @@ -52645,7 +55336,9 @@ { "title": "Properties", "kind": 1024, - "children": [138] + "children": [ + 138 + ] } ] } @@ -52786,7 +55479,9 @@ { "title": "Properties", "kind": 1024, - "children": [150] + "children": [ + 150 + ] } ] } @@ -52948,7 +55643,9 @@ { "title": "Properties", "kind": 1024, - "children": [163] + "children": [ + 163 + ] } ] } @@ -53228,7 +55925,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -53517,7 +56219,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -53806,7 +56513,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -54095,7 +56807,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -54233,7 +56950,9 @@ { "title": "Properties", "kind": 1024, - "children": [216] + "children": [ + 216 + ] } ] } @@ -54320,7 +57039,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 223, + 222 + ] } ], "indexSignature": { @@ -54514,7 +57236,9 @@ { "title": "Properties", "kind": 1024, - "children": [230] + "children": [ + 230 + ] } ], "indexSignature": { @@ -55061,17 +57785,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -55428,7 +58175,17 @@ { "title": "Properties", "kind": 1024, - "children": [447, 446, 449, 444, 445, 453, 448, 443, 442] + "children": [ + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 + ] } ], "sources": [ @@ -56047,7 +58804,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -56250,7 +59012,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -56315,7 +59080,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -56333,7 +59100,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -56351,7 +59121,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -56786,7 +59558,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -57065,7 +59843,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -57130,7 +59911,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -57148,7 +59931,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -57166,7 +59952,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -57203,22 +59991,52 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, - 365, 351, 340, 348, 354, 350, 349, 356, 357, 358, - 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, 395 ] } @@ -57409,7 +60227,12 @@ { "title": "Properties", "kind": 1024, - "children": [90, 86, 91, 85] + "children": [ + 90, + 86, + 91, + 85 + ] } ], "sources": [ @@ -57592,7 +60415,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -57657,7 +60483,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -57675,7 +60503,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -57693,7 +60524,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -57894,12 +60727,17 @@ { "title": "Properties", "kind": 1024, - "children": [46, 47] + "children": [ + 46, + 47 + ] }, { "title": "Methods", "kind": 2048, - "children": [48] + "children": [ + 48 + ] } ] } @@ -58138,12 +60976,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -58219,21 +61065,53 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, - 340, 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395 + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 ] } ], @@ -58370,7 +61248,9 @@ { "title": "Properties", "kind": 1024, - "children": [138] + "children": [ + 138 + ] } ] } @@ -58511,7 +61391,9 @@ { "title": "Properties", "kind": 1024, - "children": [150] + "children": [ + 150 + ] } ] } @@ -58673,7 +61555,9 @@ { "title": "Properties", "kind": 1024, - "children": [163] + "children": [ + 163 + ] } ] } @@ -58953,7 +61837,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -59242,7 +62131,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -59531,7 +62425,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -59820,7 +62719,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -59958,7 +62862,9 @@ { "title": "Properties", "kind": 1024, - "children": [216] + "children": [ + 216 + ] } ] } @@ -60045,7 +62951,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 223, + 222 + ] } ], "indexSignature": { @@ -60239,7 +63148,9 @@ { "title": "Properties", "kind": 1024, - "children": [230] + "children": [ + 230 + ] } ], "indexSignature": { @@ -60786,17 +63697,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -60886,20 +63820,54 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, 348, 354, 350, 349, - 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] } ], "sources": [ @@ -61122,7 +64090,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -61187,7 +64158,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -61205,7 +64178,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -61223,7 +64199,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -61596,8 +64574,15 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, - 448, 443, 442 + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 ] } ], @@ -62217,7 +65202,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -62421,7 +65411,8 @@ "title": "Properties", "kind": 1024, "children": [ - 323, 322 + 323, + 322 ] } ], @@ -62487,7 +65478,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -62505,7 +65498,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -62523,7 +65519,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -62959,7 +65957,11 @@ "title": "Properties", "kind": 1024, "children": [ - 460, 463, 461, 462, 459 + 460, + 463, + 461, + 462, + 459 ] } ], @@ -63151,22 +66153,52 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, - 365, 351, 340, 348, 354, 350, 349, 356, 357, 358, - 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, 395 ] } @@ -63357,7 +66389,12 @@ { "title": "Properties", "kind": 1024, - "children": [90, 86, 91, 85] + "children": [ + 90, + 86, + 91, + 85 + ] } ], "sources": [ @@ -63540,7 +66577,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -63605,7 +66645,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -63623,7 +66665,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -63641,7 +66686,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -63685,12 +66732,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -64102,7 +67157,14 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, 443, + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, 442 ] } @@ -64723,7 +67785,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -64926,7 +67993,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -64991,7 +68061,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -65009,7 +68081,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -65027,7 +68102,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -65462,7 +68539,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -65653,21 +68736,53 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, - 340, 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395 + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 ] } ], @@ -65804,7 +68919,9 @@ { "title": "Properties", "kind": 1024, - "children": [138] + "children": [ + 138 + ] } ] } @@ -65945,7 +69062,9 @@ { "title": "Properties", "kind": 1024, - "children": [150] + "children": [ + 150 + ] } ] } @@ -66107,7 +69226,9 @@ { "title": "Properties", "kind": 1024, - "children": [163] + "children": [ + 163 + ] } ] } @@ -66387,7 +69508,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -66676,7 +69802,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -66965,7 +70096,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -67254,7 +70390,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -67392,7 +70533,9 @@ { "title": "Properties", "kind": 1024, - "children": [216] + "children": [ + 216 + ] } ] } @@ -67479,7 +70622,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 223, + 222 + ] } ], "indexSignature": { @@ -67673,7 +70819,9 @@ { "title": "Properties", "kind": 1024, - "children": [230] + "children": [ + 230 + ] } ], "indexSignature": { @@ -68220,17 +71368,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -68364,12 +71535,17 @@ { "title": "Properties", "kind": 1024, - "children": [46, 47] + "children": [ + 46, + 47 + ] }, { "title": "Methods", "kind": 2048, - "children": [48] + "children": [ + 48 + ] } ] } @@ -68556,7 +71732,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -68621,7 +71800,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -68639,7 +71820,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -68657,7 +71841,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -69030,7 +72216,14 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, 443, + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, 442 ] } @@ -69651,7 +72844,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -69854,7 +73052,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -69919,7 +73120,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -69937,7 +73140,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -69955,7 +73161,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -70390,7 +73598,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -70581,21 +73795,53 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, - 340, 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395 + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 ] } ], @@ -70785,7 +74031,12 @@ { "title": "Properties", "kind": 1024, - "children": [90, 86, 91, 85] + "children": [ + 90, + 86, + 91, + 85 + ] } ], "sources": [ @@ -70968,7 +74219,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -71033,7 +74287,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -71051,7 +74307,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -71069,7 +74328,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -71113,12 +74374,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -71530,7 +74799,15 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, 443, 442 + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 ] } ], @@ -72150,7 +75427,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -72353,7 +75635,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -72418,7 +75703,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -72436,7 +75723,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -72454,7 +75744,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -72889,7 +76181,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -73080,20 +76378,54 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, - 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] } ], "sources": [ @@ -73229,7 +76561,9 @@ { "title": "Properties", "kind": 1024, - "children": [138] + "children": [ + 138 + ] } ] } @@ -73370,7 +76704,9 @@ { "title": "Properties", "kind": 1024, - "children": [150] + "children": [ + 150 + ] } ] } @@ -73532,7 +76868,9 @@ { "title": "Properties", "kind": 1024, - "children": [163] + "children": [ + 163 + ] } ] } @@ -73812,7 +77150,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -74101,7 +77444,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -74390,7 +77738,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -74679,7 +78032,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -74817,7 +78175,9 @@ { "title": "Properties", "kind": 1024, - "children": [216] + "children": [ + 216 + ] } ] } @@ -74904,7 +78264,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 223, + 222 + ] } ], "indexSignature": { @@ -75098,7 +78461,9 @@ { "title": "Properties", "kind": 1024, - "children": [230] + "children": [ + 230 + ] } ], "indexSignature": { @@ -75645,17 +79010,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -75885,12 +79273,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -76017,7 +79413,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -76082,7 +79481,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -76100,7 +79501,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -76118,7 +79522,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -76451,7 +79857,17 @@ { "title": "Properties", "kind": 1024, - "children": [447, 446, 449, 444, 445, 453, 448, 443, 442] + "children": [ + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 + ] } ], "sources": [ @@ -76583,7 +79999,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -76736,7 +80158,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -76975,7 +80402,11 @@ { "title": "Properties", "kind": 1024, - "children": [478, 479, 480] + "children": [ + 478, + 479, + 480 + ] } ], "sources": [ @@ -77147,7 +80578,11 @@ { "title": "Properties", "kind": 1024, - "children": [488, 489, 490] + "children": [ + 488, + 489, + 490 + ] } ], "sources": [ @@ -77331,7 +80766,11 @@ { "title": "Properties", "kind": 1024, - "children": [497, 498, 500] + "children": [ + 497, + 498, + 500 + ] } ], "sources": [ @@ -77518,7 +80957,11 @@ { "title": "Properties", "kind": 1024, - "children": [497, 498, 500] + "children": [ + 497, + 498, + 500 + ] } ], "sources": [ @@ -77694,7 +81137,11 @@ { "title": "Properties", "kind": 1024, - "children": [478, 479, 480] + "children": [ + 478, + 479, + 480 + ] } ], "sources": [ @@ -77866,7 +81313,11 @@ { "title": "Properties", "kind": 1024, - "children": [488, 489, 490] + "children": [ + 488, + 489, + 490 + ] } ], "sources": [ @@ -78059,7 +81510,12 @@ { "title": "Properties", "kind": 1024, - "children": [509, 507, 508, 510] + "children": [ + 509, + 507, + 508, + 510 + ] } ], "sources": [ @@ -78250,7 +81706,12 @@ { "title": "Properties", "kind": 1024, - "children": [519, 517, 518, 520] + "children": [ + 519, + 517, + 518, + 520 + ] } ], "sources": [ @@ -78429,17 +81890,40 @@ { "title": "Enumerations", "kind": 8, - "children": [535, 539, 544, 548] + "children": [ + 535, + 539, + 544, + 548 + ] }, { "title": "Classes", "kind": 128, - "children": [64, 328, 1] + "children": [ + 64, + 328, + 1 + ] }, { "title": "Type Aliases", "kind": 4194304, - "children": [316, 327, 440, 457, 464, 471, 495, 476, 486, 505, 515, 525, 534] + "children": [ + 316, + 327, + 440, + 457, + 464, + 471, + 495, + 476, + 486, + 505, + 515, + 525, + 534 + ] } ], "sources": [ @@ -78642,7 +82126,11 @@ { "title": "Properties", "kind": 1024, - "children": [452, 451, 453] + "children": [ + 452, + 451, + 453 + ] } ] } @@ -78655,17 +82143,23 @@ { "title": "Constructors", "kind": 512, - "children": [443] + "children": [ + 443 + ] }, { "title": "Properties", "kind": 1024, - "children": [447] + "children": [ + 447 + ] }, { "title": "Methods", "kind": 2048, - "children": [448] + "children": [ + 448 + ] } ], "sources": [ @@ -79005,7 +82499,11 @@ { "title": "Properties", "kind": 1024, - "children": [347, 346, 345] + "children": [ + 347, + 346, + 345 + ] } ] } @@ -79082,7 +82580,10 @@ { "title": "Properties", "kind": 1024, - "children": [349, 350] + "children": [ + 349, + 350 + ] } ] } @@ -79138,7 +82639,10 @@ { "title": "Properties", "kind": 1024, - "children": [352, 353] + "children": [ + 352, + 353 + ] } ] } @@ -79262,7 +82766,9 @@ { "title": "Properties", "kind": 1024, - "children": [387] + "children": [ + 387 + ] } ] } @@ -79291,7 +82797,10 @@ { "title": "Properties", "kind": 1024, - "children": [385, 388] + "children": [ + 385, + 388 + ] } ] } @@ -79347,7 +82856,10 @@ { "title": "Properties", "kind": 1024, - "children": [390, 391] + "children": [ + 390, + 391 + ] } ] } @@ -79471,7 +82983,9 @@ { "title": "Properties", "kind": 1024, - "children": [376] + "children": [ + 376 + ] } ] } @@ -79500,7 +83014,10 @@ { "title": "Properties", "kind": 1024, - "children": [374, 377] + "children": [ + 374, + 377 + ] } ] } @@ -79556,7 +83073,10 @@ { "title": "Properties", "kind": 1024, - "children": [379, 380] + "children": [ + 379, + 380 + ] } ] } @@ -79724,7 +83244,10 @@ { "title": "Properties", "kind": 1024, - "children": [335, 336] + "children": [ + 335, + 336 + ] } ] } @@ -79780,7 +83303,10 @@ { "title": "Properties", "kind": 1024, - "children": [338, 339] + "children": [ + 338, + 339 + ] } ] } @@ -79888,7 +83414,10 @@ { "title": "Properties", "kind": 1024, - "children": [326, 327] + "children": [ + 326, + 327 + ] } ] } @@ -79944,7 +83473,10 @@ { "title": "Properties", "kind": 1024, - "children": [329, 330] + "children": [ + 329, + 330 + ] } ] } @@ -80119,7 +83651,11 @@ { "title": "Properties", "kind": 1024, - "children": [361, 360, 359] + "children": [ + 361, + 360, + 359 + ] } ] } @@ -80186,7 +83722,9 @@ { "title": "Properties", "kind": 1024, - "children": [365] + "children": [ + 365 + ] } ] } @@ -80215,7 +83753,10 @@ { "title": "Properties", "kind": 1024, - "children": [363, 366] + "children": [ + 363, + 366 + ] } ] } @@ -80271,7 +83812,10 @@ { "title": "Properties", "kind": 1024, - "children": [368, 369] + "children": [ + 368, + 369 + ] } ] } @@ -80301,12 +83845,22 @@ { "title": "Constructors", "kind": 512, - "children": [298] + "children": [ + 298 + ] }, { "title": "Methods", "kind": 2048, - "children": [340, 381, 370, 310, 331, 323, 354] + "children": [ + 340, + 381, + 370, + 310, + 331, + 323, + 354 + ] } ], "sources": [ @@ -80385,7 +83939,9 @@ { "title": "Constructors", "kind": 512, - "children": [438] + "children": [ + 438 + ] } ], "sources": [ @@ -80508,12 +84064,16 @@ { "title": "Constructors", "kind": 512, - "children": [456] + "children": [ + 456 + ] }, { "title": "Properties", "kind": 1024, - "children": [460] + "children": [ + 460 + ] } ], "sources": [ @@ -80694,7 +84254,16 @@ { "title": "Properties", "kind": 1024, - "children": [397, 398, 396, 393, 394, 395, 400, 399] + "children": [ + 397, + 398, + 396, + 393, + 394, + 395, + 400, + 399 + ] } ], "sources": [ @@ -80742,7 +84311,9 @@ { "title": "Properties", "kind": 1024, - "children": [425] + "children": [ + 425 + ] } ], "sources": [ @@ -80958,7 +84529,16 @@ { "title": "Properties", "kind": 1024, - "children": [397, 398, 396, 393, 394, 395, 400, 399] + "children": [ + 397, + 398, + 396, + 393, + 394, + 395, + 400, + 399 + ] } ], "sources": [ @@ -81114,7 +84694,17 @@ { "title": "Properties", "kind": 1024, - "children": [403, 410, 407, 405, 408, 409, 402, 404, 406] + "children": [ + 403, + 410, + 407, + 405, + 408, + 409, + 402, + 404, + 406 + ] } ], "sources": [ @@ -81229,7 +84819,12 @@ { "title": "Properties", "kind": 1024, - "children": [415, 416, 418, 417] + "children": [ + 415, + 416, + 418, + 417 + ] } ], "sources": [ @@ -81270,7 +84865,9 @@ { "title": "Properties", "kind": 1024, - "children": [427] + "children": [ + 427 + ] } ], "sources": [ @@ -81431,7 +85028,10 @@ { "title": "Properties", "kind": 1024, - "children": [412, 413] + "children": [ + 412, + 413 + ] } ], "sources": [ @@ -81449,7 +85049,12 @@ { "title": "Properties", "kind": 1024, - "children": [420, 421, 423, 422] + "children": [ + 420, + 421, + 423, + 422 + ] } ], "sources": [ @@ -81512,7 +85117,10 @@ { "title": "Properties", "kind": 1024, - "children": [412, 413] + "children": [ + 412, + 413 + ] } ], "sources": [ @@ -81664,7 +85272,13 @@ { "title": "Properties", "kind": 1024, - "children": [433, 430, 432, 431, 429] + "children": [ + 433, + 430, + 432, + 431, + 429 + ] } ], "sources": [ @@ -81726,17 +85340,33 @@ { "title": "Classes", "kind": 128, - "children": [442, 297, 437, 455] + "children": [ + 442, + 297, + 437, + 455 + ] }, { "title": "Interfaces", "kind": 256, - "children": [392, 424, 401, 414, 426, 419, 411, 428] + "children": [ + 392, + 424, + 401, + 414, + 426, + 419, + 411, + 428 + ] }, { "title": "Functions", "kind": 64, - "children": [434] + "children": [ + 434 + ] } ], "sources": [ @@ -82066,7 +85696,11 @@ { "title": "Properties", "kind": 1024, - "children": [50, 49, 48] + "children": [ + 50, + 49, + 48 + ] } ] } @@ -82143,7 +85777,10 @@ { "title": "Properties", "kind": 1024, - "children": [52, 53] + "children": [ + 52, + 53 + ] } ] } @@ -82199,7 +85836,10 @@ { "title": "Properties", "kind": 1024, - "children": [55, 56] + "children": [ + 55, + 56 + ] } ] } @@ -82313,7 +85953,9 @@ { "title": "Properties", "kind": 1024, - "children": [90] + "children": [ + 90 + ] } ] } @@ -82342,7 +85984,10 @@ { "title": "Properties", "kind": 1024, - "children": [88, 91] + "children": [ + 88, + 91 + ] } ] } @@ -82398,7 +86043,10 @@ { "title": "Properties", "kind": 1024, - "children": [93, 94] + "children": [ + 93, + 94 + ] } ] } @@ -82512,7 +86160,9 @@ { "title": "Properties", "kind": 1024, - "children": [79] + "children": [ + 79 + ] } ] } @@ -82541,7 +86191,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 80] + "children": [ + 77, + 80 + ] } ] } @@ -82597,7 +86250,10 @@ { "title": "Properties", "kind": 1024, - "children": [82, 83] + "children": [ + 82, + 83 + ] } ] } @@ -82708,7 +86364,10 @@ { "title": "Properties", "kind": 1024, - "children": [38, 39] + "children": [ + 38, + 39 + ] } ] } @@ -82764,7 +86423,10 @@ { "title": "Properties", "kind": 1024, - "children": [41, 42] + "children": [ + 41, + 42 + ] } ] } @@ -82862,7 +86524,10 @@ { "title": "Properties", "kind": 1024, - "children": [29, 30] + "children": [ + 29, + 30 + ] } ] } @@ -82918,7 +86583,10 @@ { "title": "Properties", "kind": 1024, - "children": [32, 33] + "children": [ + 32, + 33 + ] } ] } @@ -83083,7 +86751,11 @@ { "title": "Properties", "kind": 1024, - "children": [64, 63, 62] + "children": [ + 64, + 63, + 62 + ] } ] } @@ -83150,7 +86822,9 @@ { "title": "Properties", "kind": 1024, - "children": [68] + "children": [ + 68 + ] } ] } @@ -83179,7 +86853,10 @@ { "title": "Properties", "kind": 1024, - "children": [66, 69] + "children": [ + 66, + 69 + ] } ] } @@ -83235,7 +86912,10 @@ { "title": "Properties", "kind": 1024, - "children": [71, 72] + "children": [ + 71, + 72 + ] } ] } @@ -83255,12 +86935,21 @@ { "title": "Constructors", "kind": 512, - "children": [4] + "children": [ + 4 + ] }, { "title": "Methods", "kind": 2048, - "children": [43, 84, 73, 34, 26, 57] + "children": [ + 43, + 84, + 73, + 34, + 26, + 57 + ] } ], "sources": [ @@ -83283,7 +86972,9 @@ { "title": "Classes", "kind": 128, - "children": [3] + "children": [ + 3 + ] } ], "sources": [ @@ -83588,7 +87279,9 @@ { "title": "Properties", "kind": 1024, - "children": [207] + "children": [ + 207 + ] } ] } @@ -83617,7 +87310,10 @@ { "title": "Properties", "kind": 1024, - "children": [205, 208] + "children": [ + 205, + 208 + ] } ] } @@ -83673,7 +87369,10 @@ { "title": "Properties", "kind": 1024, - "children": [210, 211] + "children": [ + 210, + 211 + ] } ] } @@ -83823,7 +87522,11 @@ { "title": "Properties", "kind": 1024, - "children": [170, 168, 169] + "children": [ + 170, + 168, + 169 + ] } ] } @@ -83852,7 +87555,10 @@ { "title": "Properties", "kind": 1024, - "children": [166, 171] + "children": [ + 166, + 171 + ] } ] } @@ -83908,7 +87614,10 @@ { "title": "Properties", "kind": 1024, - "children": [173, 174] + "children": [ + 173, + 174 + ] } ] } @@ -84187,7 +87896,13 @@ { "title": "Properties", "kind": 1024, - "children": [433, 430, 432, 431, 429] + "children": [ + 433, + 430, + 432, + 431, + 429 + ] } ], "sources": [ @@ -84205,7 +87920,10 @@ { "title": "Properties", "kind": 1024, - "children": [218, 219] + "children": [ + 218, + 219 + ] } ] } @@ -84272,7 +87990,9 @@ { "title": "Properties", "kind": 1024, - "children": [223] + "children": [ + 223 + ] } ] } @@ -84301,7 +88021,10 @@ { "title": "Properties", "kind": 1024, - "children": [221, 224] + "children": [ + 221, + 224 + ] } ] } @@ -84357,7 +88080,10 @@ { "title": "Properties", "kind": 1024, - "children": [226, 227] + "children": [ + 226, + 227 + ] } ] } @@ -84479,7 +88205,9 @@ { "title": "Properties", "kind": 1024, - "children": [234] + "children": [ + 234 + ] } ] } @@ -84602,7 +88330,11 @@ { "title": "Properties", "kind": 1024, - "children": [238, 239, 240] + "children": [ + 238, + 239, + 240 + ] } ] } @@ -84632,7 +88364,10 @@ { "title": "Properties", "kind": 1024, - "children": [236, 241] + "children": [ + 236, + 241 + ] } ] } @@ -84688,7 +88423,10 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244] + "children": [ + 243, + 244 + ] } ] } @@ -84921,7 +88659,13 @@ { "title": "Properties", "kind": 1024, - "children": [433, 430, 432, 431, 429] + "children": [ + 433, + 430, + 432, + 431, + 429 + ] } ], "sources": [ @@ -84939,7 +88683,9 @@ { "title": "Properties", "kind": 1024, - "children": [250] + "children": [ + 250 + ] } ] } @@ -85004,7 +88750,10 @@ { "title": "Properties", "kind": 1024, - "children": [252, 253] + "children": [ + 252, + 253 + ] } ] } @@ -85060,7 +88809,10 @@ { "title": "Properties", "kind": 1024, - "children": [255, 256] + "children": [ + 255, + 256 + ] } ] } @@ -85325,7 +89077,13 @@ { "title": "Properties", "kind": 1024, - "children": [433, 430, 432, 431, 429] + "children": [ + 433, + 430, + 432, + 431, + 429 + ] } ], "sources": [ @@ -85343,7 +89101,10 @@ { "title": "Properties", "kind": 1024, - "children": [262, 263] + "children": [ + 262, + 263 + ] } ] } @@ -85404,7 +89165,9 @@ { "title": "Properties", "kind": 1024, - "children": [267] + "children": [ + 267 + ] } ] } @@ -85415,7 +89178,9 @@ { "title": "Properties", "kind": 1024, - "children": [265] + "children": [ + 265 + ] } ] } @@ -85625,7 +89390,10 @@ { "title": "Properties", "kind": 1024, - "children": [412, 413] + "children": [ + 412, + 413 + ] } ], "sources": [ @@ -85643,7 +89411,12 @@ { "title": "Properties", "kind": 1024, - "children": [420, 421, 423, 422] + "children": [ + 420, + 421, + 423, + 422 + ] } ], "sources": [ @@ -85705,7 +89478,9 @@ { "title": "Properties", "kind": 1024, - "children": [425] + "children": [ + 425 + ] } ], "sources": [ @@ -85779,7 +89554,10 @@ { "title": "Properties", "kind": 1024, - "children": [283, 284] + "children": [ + 283, + 284 + ] } ] } @@ -85835,7 +89613,10 @@ { "title": "Properties", "kind": 1024, - "children": [286, 287] + "children": [ + 286, + 287 + ] } ] } @@ -85963,7 +89744,9 @@ { "title": "Properties", "kind": 1024, - "children": [195] + "children": [ + 195 + ] } ] } @@ -85992,7 +89775,10 @@ { "title": "Properties", "kind": 1024, - "children": [193, 196] + "children": [ + 193, + 196 + ] } ] } @@ -86048,7 +89834,10 @@ { "title": "Properties", "kind": 1024, - "children": [198, 199] + "children": [ + 198, + 199 + ] } ] } @@ -86165,7 +89954,10 @@ { "title": "Properties", "kind": 1024, - "children": [272, 273] + "children": [ + 272, + 273 + ] } ] } @@ -86221,7 +90013,10 @@ { "title": "Properties", "kind": 1024, - "children": [275, 276] + "children": [ + 275, + 276 + ] } ] } @@ -86471,7 +90266,12 @@ { "title": "Properties", "kind": 1024, - "children": [415, 416, 418, 417] + "children": [ + 415, + 416, + 418, + 417 + ] } ], "sources": [ @@ -86545,7 +90345,9 @@ { "title": "Properties", "kind": 1024, - "children": [183] + "children": [ + 183 + ] } ] } @@ -86574,7 +90376,10 @@ { "title": "Properties", "kind": 1024, - "children": [181, 184] + "children": [ + 181, + 184 + ] } ] } @@ -86630,7 +90435,10 @@ { "title": "Properties", "kind": 1024, - "children": [186, 187] + "children": [ + 186, + 187 + ] } ] } @@ -86813,7 +90621,12 @@ { "title": "Properties", "kind": 1024, - "children": [415, 416, 418, 417] + "children": [ + 415, + 416, + 418, + 417 + ] } ], "sources": [ @@ -86887,7 +90700,9 @@ { "title": "Properties", "kind": 1024, - "children": [143] + "children": [ + 143 + ] } ] } @@ -86916,7 +90731,10 @@ { "title": "Properties", "kind": 1024, - "children": [141, 144] + "children": [ + 141, + 144 + ] } ] } @@ -86972,7 +90790,10 @@ { "title": "Properties", "kind": 1024, - "children": [146, 147] + "children": [ + 146, + 147 + ] } ] } @@ -87169,7 +90990,12 @@ { "title": "Properties", "kind": 1024, - "children": [415, 416, 418, 417] + "children": [ + 415, + 416, + 418, + 417 + ] } ], "sources": [ @@ -87244,7 +91070,9 @@ { "title": "Properties", "kind": 1024, - "children": [157] + "children": [ + 157 + ] } ] } @@ -87275,7 +91103,10 @@ { "title": "Properties", "kind": 1024, - "children": [155, 158] + "children": [ + 155, + 158 + ] } ] } @@ -87324,7 +91155,10 @@ { "title": "Properties", "kind": 1024, - "children": [160, 161] + "children": [ + 160, + 161 + ] } ] } @@ -87344,12 +91178,27 @@ { "title": "Constructors", "kind": 512, - "children": [97] + "children": [ + 97 + ] }, { "title": "Methods", "kind": 2048, - "children": [200, 162, 212, 228, 245, 257, 277, 188, 268, 175, 135, 148] + "children": [ + 200, + 162, + 212, + 228, + 245, + 257, + 277, + 188, + 268, + 175, + 135, + 148 + ] } ], "sources": [ @@ -87365,7 +91214,9 @@ { "title": "Classes", "kind": 128, - "children": [96] + "children": [ + 96 + ] } ], "sources": [ @@ -87381,7 +91232,11 @@ { "title": "Modules", "kind": 2, - "children": [1, 2, 95] + "children": [ + 1, + 2, + 95 + ] } ] }, @@ -87574,7 +91429,10 @@ { "title": "Properties", "kind": 1024, - "children": [8, 7] + "children": [ + 8, + 7 + ] } ] } @@ -88008,7 +91866,11 @@ { "title": "Properties", "kind": 1024, - "children": [35, 30, 34] + "children": [ + 35, + 30, + 34 + ] } ], "sources": [ @@ -88099,17 +91961,26 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [ + 2 + ] }, { "title": "Properties", "kind": 1024, - "children": [15, 14, 13] + "children": [ + 15, + 14, + 13 + ] }, { "title": "Methods", "kind": 2048, - "children": [23, 20] + "children": [ + 23, + 20 + ] } ], "sources": [ @@ -88224,12 +92095,16 @@ { "title": "Constructors", "kind": 512, - "children": [37] + "children": [ + 37 + ] }, { "title": "Properties", "kind": 1024, - "children": [42] + "children": [ + 42 + ] } ], "sources": [ @@ -88351,12 +92226,16 @@ { "title": "Constructors", "kind": 512, - "children": [44] + "children": [ + 44 + ] }, { "title": "Properties", "kind": 1024, - "children": [47] + "children": [ + 47 + ] } ], "sources": [ @@ -88460,12 +92339,16 @@ { "title": "Constructors", "kind": 512, - "children": [49] + "children": [ + 49 + ] }, { "title": "Properties", "kind": 1024, - "children": [52] + "children": [ + 52 + ] } ], "sources": [ @@ -88569,12 +92452,16 @@ { "title": "Constructors", "kind": 512, - "children": [54] + "children": [ + 54 + ] }, { "title": "Properties", "kind": 1024, - "children": [57] + "children": [ + 57 + ] } ], "sources": [ @@ -88804,7 +92691,11 @@ { "title": "Properties", "kind": 1024, - "children": [35, 30, 34] + "children": [ + 35, + 30, + 34 + ] } ], "sources": [ @@ -88841,7 +92732,10 @@ ], "type": { "type": "union", - "types": [null, null] + "types": [ + null, + null + ] } } ], @@ -88849,12 +92743,21 @@ { "title": "Classes", "kind": 128, - "children": [1, 36, 43, 48, 53] + "children": [ + 1, + 36, + 43, + 48, + 53 + ] }, { "title": "Type Aliases", "kind": 4194304, - "children": [28, 58] + "children": [ + 28, + 58 + ] } ], "sources": [ diff --git a/spec/enrichments/tsdoc_v2/functions.json b/spec/enrichments/tsdoc_v2/functions.json index 419e9def96f..bee062bb846 100644 --- a/spec/enrichments/tsdoc_v2/functions.json +++ b/spec/enrichments/tsdoc_v2/functions.json @@ -1,1271 +1,1312 @@ { - "id": 0, - "name": "@supabase/functions-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1, - "name": "FunctionsClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 16, - "character": 2 - } - ], - "signatures": [ - { - "id": 3, - "name": "new FunctionsClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 4, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 6, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 8, - "name": "customFetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 23, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 10, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 11, - "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": 12, - "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/FunctionsClient.ts", - "line": 22, - "character": 6 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [8, 7] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "FunctionsClient" - } - } - ] - }, - { - "id": 15, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 17, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 18, - "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": 19, - "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": 14, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 13, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 12, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 23, - "name": "invoke", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 44, - "character": 8 - } - ], - "signatures": [ - { - "id": 24, - "name": "invoke", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Invokes a function" - }, - "typeParameter": [ - { - "id": 25, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - } - ], - "parameters": [ - { - "id": 26, - "name": "functionName", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The name of the Function to invoke." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 27, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Options for invoking the Function.\n" - }, - "type": { - "type": "reference", - "id": 28, - "name": "FunctionInvokeOptions" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 58, - "typeArguments": [ - { - "type": "reference", - "id": 25, - "name": "T" - } - ], - "name": "FunctionsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 20, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 35, - "character": 2 - } - ], - "signatures": [ - { - "id": 21, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates the authorization header" - }, - "parameters": [ - { - "id": 22, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "the new jwt token sent in the authorisation header\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [2] - }, - { - "title": "Properties", - "kind": 1024, - "children": [15, 14, 13] - }, - { - "title": "Methods", - "kind": 2048, - "children": [23, 20] - } - ], - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 11, - "character": 13 - } - ] - }, - { - "id": 36, - "name": "FunctionsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 37, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 19, - "character": 2 - } - ], - "signatures": [ - { - "id": 38, - "name": "new FunctionsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 39, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 40, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'FunctionsError'" - }, - { - "id": 41, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "id": 36, - "name": "FunctionsError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 42, - "name": "context", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [37] - }, - { - "title": "Properties", - "kind": 1024, - "children": [42] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 17, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 43, - "name": "FunctionsFetchError" - }, - { - "type": "reference", - "id": 48, - "name": "FunctionsHttpError" - }, - { - "type": "reference", - "id": 53, - "name": "FunctionsRelayError" - } - ] - }, - { - "id": 43, - "name": "FunctionsFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 44, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 27, - "character": 2 - } - ], - "signatures": [ - { - "id": 45, - "name": "new FunctionsFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 46, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "id": 43, - "name": "FunctionsFetchError" - }, - "overwrites": { - "type": "reference", - "id": 38, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 37, - "name": "FunctionsError.constructor" - } - }, - { - "id": 47, - "name": "context", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "id": 42, - "name": "FunctionsError.context" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [44] - }, - { - "title": "Properties", - "kind": 1024, - "children": [47] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 26, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 36, - "name": "FunctionsError" - } - ] - }, - { - "id": 48, - "name": "FunctionsHttpError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 49, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 39, - "character": 2 - } - ], - "signatures": [ - { - "id": 50, - "name": "new FunctionsHttpError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 51, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "id": 48, - "name": "FunctionsHttpError" - }, - "overwrites": { - "type": "reference", - "id": 38, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 37, - "name": "FunctionsError.constructor" - } - }, - { - "id": 52, - "name": "context", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "id": 42, - "name": "FunctionsError.context" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [49] - }, - { - "title": "Properties", - "kind": 1024, - "children": [52] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 38, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 36, - "name": "FunctionsError" - } - ] - }, - { - "id": 53, - "name": "FunctionsRelayError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 54, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 33, - "character": 2 - } - ], - "signatures": [ - { - "id": 55, - "name": "new FunctionsRelayError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 56, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "id": 53, - "name": "FunctionsRelayError" - }, - "overwrites": { - "type": "reference", - "id": 38, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 37, - "name": "FunctionsError.constructor" - } - }, - { - "id": 57, - "name": "context", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "id": 42, - "name": "FunctionsError.context" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [54] - }, - { - "title": "Properties", - "kind": 1024, - "children": [57] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 32, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 36, - "name": "FunctionsError" - } - ] - }, - { - "id": 28, - "name": "FunctionInvokeOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 44, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 29, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 35, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The body of the request." - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "File", - "package": "typescript", - "name": "File" - }, - { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - }, - { - "type": "reference", - "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" - }, - { - "type": "reference", - "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - ], - "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 30, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Object representing the headers to send with the request." - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 31, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 48, - "character": 12 - } - ], - "indexSignature": { - "id": 32, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 33, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 34, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The HTTP verb of the request" - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 52, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [35, 30, 34] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 44, - "character": 36 - } - ] - } - } - }, - { - "id": 58, - "name": "FunctionsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 15, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 59, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 59, - "name": "T" - } - ], - "name": "FunctionsResponseSuccess" - }, - { - "type": "reference", - "name": "FunctionsResponseFailure" - } - ] - } - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [1, 36, 43, 48, 53] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [28, 58] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] -} + "id": 0, + "name": "@supabase/functions-js", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 1, + "name": "FunctionsClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 2, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/FunctionsClient.ts", + "line": 16, + "character": 2 + } + ], + "signatures": [ + { + "id": 3, + "name": "new FunctionsClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 4, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 6, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 8, + "name": "customFetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/FunctionsClient.ts", + "line": 23, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 9, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 10, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 11, + "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": 12, + "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/FunctionsClient.ts", + "line": 22, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 8, + 7 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "FunctionsClient" + } + } + ] + }, + { + "id": 15, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/FunctionsClient.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 16, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 17, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 18, + "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": 19, + "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": 14, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/FunctionsClient.ts", + "line": 13, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 13, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/FunctionsClient.ts", + "line": 12, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 23, + "name": "invoke", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/FunctionsClient.ts", + "line": 44, + "character": 8 + } + ], + "signatures": [ + { + "id": 24, + "name": "invoke", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Invokes a function" + }, + "typeParameter": [ + { + "id": 25, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + } + ], + "parameters": [ + { + "id": 26, + "name": "functionName", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The name of the Function to invoke." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 27, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Options for invoking the Function.\n" + }, + "type": { + "type": "reference", + "id": 28, + "name": "FunctionInvokeOptions" + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 58, + "typeArguments": [ + { + "type": "reference", + "id": 25, + "name": "T" + } + ], + "name": "FunctionsResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 20, + "name": "setAuth", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/FunctionsClient.ts", + "line": 35, + "character": 2 + } + ], + "signatures": [ + { + "id": 21, + "name": "setAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates the authorization header" + }, + "parameters": [ + { + "id": 22, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "the new jwt token sent in the authorisation header\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 2 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 15, + 14, + 13 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 23, + 20 + ] + } + ], + "sources": [ + { + "fileName": "src/FunctionsClient.ts", + "line": 11, + "character": 13 + } + ] + }, + { + "id": 36, + "name": "FunctionsError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 37, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 19, + "character": 2 + } + ], + "signatures": [ + { + "id": 38, + "name": "new FunctionsError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 39, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 40, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "'FunctionsError'" + }, + { + "id": 41, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "id": 36, + "name": "FunctionsError" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 42, + "name": "context", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 37 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 42 + ] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 17, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 43, + "name": "FunctionsFetchError" + }, + { + "type": "reference", + "id": 48, + "name": "FunctionsHttpError" + }, + { + "type": "reference", + "id": 53, + "name": "FunctionsRelayError" + } + ] + }, + { + "id": 43, + "name": "FunctionsFetchError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 44, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 27, + "character": 2 + } + ], + "signatures": [ + { + "id": 45, + "name": "new FunctionsFetchError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 46, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "id": 43, + "name": "FunctionsFetchError" + }, + "overwrites": { + "type": "reference", + "id": 38, + "name": "FunctionsError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 37, + "name": "FunctionsError.constructor" + } + }, + { + "id": 47, + "name": "context", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "id": 42, + "name": "FunctionsError.context" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 44 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 47 + ] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 26, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 36, + "name": "FunctionsError" + } + ] + }, + { + "id": 48, + "name": "FunctionsHttpError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 49, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 39, + "character": 2 + } + ], + "signatures": [ + { + "id": 50, + "name": "new FunctionsHttpError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 51, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "id": 48, + "name": "FunctionsHttpError" + }, + "overwrites": { + "type": "reference", + "id": 38, + "name": "FunctionsError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 37, + "name": "FunctionsError.constructor" + } + }, + { + "id": 52, + "name": "context", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "id": 42, + "name": "FunctionsError.context" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 49 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 52 + ] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 38, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 36, + "name": "FunctionsError" + } + ] + }, + { + "id": 53, + "name": "FunctionsRelayError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 54, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 33, + "character": 2 + } + ], + "signatures": [ + { + "id": 55, + "name": "new FunctionsRelayError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 56, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "id": 53, + "name": "FunctionsRelayError" + }, + "overwrites": { + "type": "reference", + "id": 38, + "name": "FunctionsError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 37, + "name": "FunctionsError.constructor" + } + }, + { + "id": 57, + "name": "context", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "id": 42, + "name": "FunctionsError.context" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 54 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 57 + ] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 32, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 36, + "name": "FunctionsError" + } + ] + }, + { + "id": 28, + "name": "FunctionInvokeOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 44, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 29, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 35, + "name": "body", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The body of the request." + }, + "sources": [ + { + "fileName": "src/types.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "File", + "package": "typescript", + "name": "File" + }, + { + "type": "reference", + "qualifiedName": "Blob", + "package": "typescript", + "name": "Blob" + }, + { + "type": "reference", + "qualifiedName": "ArrayBuffer", + "package": "typescript", + "name": "ArrayBuffer" + }, + { + "type": "reference", + "qualifiedName": "FormData", + "package": "typescript", + "name": "FormData" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Uint8Array", + "package": "typescript", + "name": "Uint8Array" + } + ], + "qualifiedName": "ReadableStream", + "package": "typescript", + "name": "ReadableStream" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 30, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Object representing the headers to send with the request." + }, + "sources": [ + { + "fileName": "src/types.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 31, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 48, + "character": 12 + } + ], + "indexSignature": { + "id": 32, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 33, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 34, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The HTTP verb of the request" + }, + "sources": [ + { + "fileName": "src/types.ts", + "line": 52, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "PUT" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 35, + 30, + 34 + ] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 44, + "character": 36 + } + ] + } + } + }, + { + "id": 58, + "name": "FunctionsResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 15, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 59, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 59, + "name": "T" + } + ], + "name": "FunctionsResponseSuccess" + }, + { + "type": "reference", + "name": "FunctionsResponseFailure" + } + ] + } + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [ + 1, + 36, + 43, + 48, + 53 + ] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [ + 28, + 58 + ] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/functions_dereferenced.json b/spec/enrichments/tsdoc_v2/functions_dereferenced.json index f648d5f02df..09487d9edca 100644 --- a/spec/enrichments/tsdoc_v2/functions_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/functions_dereferenced.json @@ -187,7 +187,10 @@ { "title": "Properties", "kind": 1024, - "children": [8, 7] + "children": [ + 8, + 7 + ] } ] } @@ -621,7 +624,11 @@ { "title": "Properties", "kind": 1024, - "children": [35, 30, 34] + "children": [ + 35, + 30, + 34 + ] } ], "sources": [ @@ -712,17 +719,26 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [ + 2 + ] }, { "title": "Properties", "kind": 1024, - "children": [15, 14, 13] + "children": [ + 15, + 14, + 13 + ] }, { "title": "Methods", "kind": 2048, - "children": [23, 20] + "children": [ + 23, + 20 + ] } ], "sources": [ @@ -837,12 +853,16 @@ { "title": "Constructors", "kind": 512, - "children": [37] + "children": [ + 37 + ] }, { "title": "Properties", "kind": 1024, - "children": [42] + "children": [ + 42 + ] } ], "sources": [ @@ -964,12 +984,16 @@ { "title": "Constructors", "kind": 512, - "children": [44] + "children": [ + 44 + ] }, { "title": "Properties", "kind": 1024, - "children": [47] + "children": [ + 47 + ] } ], "sources": [ @@ -1073,12 +1097,16 @@ { "title": "Constructors", "kind": 512, - "children": [49] + "children": [ + 49 + ] }, { "title": "Properties", "kind": 1024, - "children": [52] + "children": [ + 52 + ] } ], "sources": [ @@ -1182,12 +1210,16 @@ { "title": "Constructors", "kind": 512, - "children": [54] + "children": [ + 54 + ] }, { "title": "Properties", "kind": 1024, - "children": [57] + "children": [ + 57 + ] } ], "sources": [ @@ -1417,7 +1449,11 @@ { "title": "Properties", "kind": 1024, - "children": [35, 30, 34] + "children": [ + 35, + 30, + 34 + ] } ], "sources": [ @@ -1454,7 +1490,10 @@ ], "type": { "type": "union", - "types": [null, null] + "types": [ + null, + null + ] } } ], @@ -1462,12 +1501,21 @@ { "title": "Classes", "kind": 128, - "children": [1, 36, 43, 48, 53] + "children": [ + 1, + 36, + 43, + 48, + 53 + ] }, { "title": "Type Aliases", "kind": 4194304, - "children": [28, 58] + "children": [ + 28, + 58 + ] } ], "sources": [ @@ -1477,4 +1525,4 @@ "character": 0 } ] -} +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/gotrue.json b/spec/enrichments/tsdoc_v2/gotrue.json index 1672f7b8a82..0956483919a 100644 --- a/spec/enrichments/tsdoc_v2/gotrue.json +++ b/spec/enrichments/tsdoc_v2/gotrue.json @@ -1,15380 +1,16514 @@ { - "id": 0, - "name": "@supabase/gotrue-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 791, - "name": "AuthApiError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 792, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 19, - "character": 2 - } - ], - "signatures": [ - { - "id": 793, - "name": "new AuthApiError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 794, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 795, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 791, - "name": "AuthApiError" - }, - "overwrites": { - "type": "reference", - "id": 786, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 785, - "name": "AuthError.constructor" - } - }, - { - "id": 796, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "id": 789, - "name": "AuthError.status" - } - }, - { - "id": 797, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 25, - "character": 2 - } - ], - "signatures": [ - { - "id": 798, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 799, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 801, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 28, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 800, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 27, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 802, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 29, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [801, 800, 802] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [792] - }, - { - "title": "Properties", - "kind": 1024, - "children": [796] - }, - { - "title": "Methods", - "kind": 2048, - "children": [797] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 16, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 784, - "name": "AuthError" - } - ] - }, - { - "id": 784, - "name": "AuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 785, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 5, - "character": 2 - } - ], - "signatures": [ - { - "id": 786, - "name": "new AuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 787, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 789, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [785] - }, - { - "title": "Properties", - "kind": 1024, - "children": [789] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 1, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 791, - "name": "AuthApiError" - }, - { - "type": "reference", - "id": 804, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "id": 812, - "name": "CustomAuthError" - } - ] - }, - { - "id": 852, - "name": "AuthImplicitGrantRedirectError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 853, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 80, - "character": 2 - } - ], - "signatures": [ - { - "id": 854, - "name": "new AuthImplicitGrantRedirectError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 855, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 856, - "name": "details", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 857, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 859, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 80, - "character": 57 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 858, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 80, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [859, 858] - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "id": 852, - "name": "AuthImplicitGrantRedirectError" - }, - "overwrites": { - "type": "reference", - "id": 814, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 813, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 860, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 861, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 863, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 79, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 862, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 79, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [863, 862] - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 874, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 818, - "name": "CustomAuthError.name" - } - }, - { - "id": 875, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 819, - "name": "CustomAuthError.status" - } - }, - { - "id": 864, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 85, - "character": 2 - } - ], - "signatures": [ - { - "id": 865, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 866, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 870, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 873, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 79, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 872, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 79, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [873, 872] - } - ] - } - } - ] - }, - "defaultValue": "..." - }, - { - "id": 868, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 88, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 867, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 87, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 869, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [870, 868, 867, 869] - } - ] - } - }, - "overwrites": { - "type": "reference", - "id": 821, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "id": 820, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [853] - }, - { - "title": "Properties", - "kind": 1024, - "children": [860, 874, 875] - }, - { - "title": "Methods", - "kind": 2048, - "children": [864] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 78, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 812, - "name": "CustomAuthError" - } - ] - }, - { - "id": 839, - "name": "AuthInvalidCredentialsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 840, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 2 - } - ], - "signatures": [ - { - "id": 841, - "name": "new AuthInvalidCredentialsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 842, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 839, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 814, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 813, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 843, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 818, - "name": "CustomAuthError.name" - } - }, - { - "id": 844, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 819, - "name": "CustomAuthError.status" - } - }, - { - "id": 845, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "signatures": [ - { - "id": 846, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 847, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 849, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 60, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 848, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 850, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [849, 848, 850] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 821, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 820, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [840] - }, - { - "title": "Properties", - "kind": 1024, - "children": [843, 844] - }, - { - "title": "Methods", - "kind": 2048, - "children": [845] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 72, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 812, - "name": "CustomAuthError" - } - ] - }, - { - "id": 877, - "name": "AuthPKCEGrantCodeExchangeError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 878, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 97, - "character": 2 - } - ], - "signatures": [ - { - "id": 879, - "name": "new AuthPKCEGrantCodeExchangeError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 880, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 881, - "name": "details", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 882, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 884, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 97, - "character": 57 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 883, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 97, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [884, 883] - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "id": 877, - "name": "AuthPKCEGrantCodeExchangeError" - }, - "overwrites": { - "type": "reference", - "id": 814, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 813, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 885, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 96, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 886, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 888, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 96, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 887, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 96, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [888, 887] - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 899, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 818, - "name": "CustomAuthError.name" - } - }, - { - "id": 900, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 819, - "name": "CustomAuthError.status" - } - }, - { - "id": 889, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 102, - "character": 2 - } - ], - "signatures": [ - { - "id": 890, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 891, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 895, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 107, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 896, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 898, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 96, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 897, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 96, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [898, 897] - } - ] - } - } - ] - }, - "defaultValue": "..." - }, - { - "id": 893, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 105, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 892, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 104, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 894, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 106, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [895, 893, 892, 894] - } - ] - } - }, - "overwrites": { - "type": "reference", - "id": 821, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "id": 820, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [878] - }, - { - "title": "Properties", - "kind": 1024, - "children": [885, 899, 900] - }, - { - "title": "Methods", - "kind": 2048, - "children": [889] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 95, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 812, - "name": "CustomAuthError" - } - ] - }, - { - "id": 902, - "name": "AuthRetryableFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 903, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 113, - "character": 2 - } - ], - "signatures": [ - { - "id": 904, - "name": "new AuthRetryableFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 905, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 906, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 902, - "name": "AuthRetryableFetchError" - }, - "overwrites": { - "type": "reference", - "id": 814, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 813, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 907, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 818, - "name": "CustomAuthError.name" - } - }, - { - "id": 908, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 819, - "name": "CustomAuthError.status" - } - }, - { - "id": 909, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "signatures": [ - { - "id": 910, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 911, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 913, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 60, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 912, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 914, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [913, 912, 914] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 821, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 820, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [903] - }, - { - "title": "Properties", - "kind": 1024, - "children": [907, 908] - }, - { - "title": "Methods", - "kind": 2048, - "children": [909] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 112, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 812, - "name": "CustomAuthError" - } - ] - }, - { - "id": 827, - "name": "AuthSessionMissingError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 828, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 67, - "character": 2 - } - ], - "signatures": [ - { - "id": 829, - "name": "new AuthSessionMissingError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "type": { - "type": "reference", - "id": 827, - "name": "AuthSessionMissingError" - }, - "overwrites": { - "type": "reference", - "id": 814, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 813, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 830, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 818, - "name": "CustomAuthError.name" - } - }, - { - "id": 831, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 819, - "name": "CustomAuthError.status" - } - }, - { - "id": 832, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "signatures": [ - { - "id": 833, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 834, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 836, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 60, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 835, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 837, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [836, 835, 837] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 821, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 820, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [828] - }, - { - "title": "Properties", - "kind": 1024, - "children": [830, 831] - }, - { - "title": "Methods", - "kind": 2048, - "children": [832] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 66, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 812, - "name": "CustomAuthError" - } - ] - }, - { - "id": 804, - "name": "AuthUnknownError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 805, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 41, - "character": 2 - } - ], - "signatures": [ - { - "id": 806, - "name": "new AuthUnknownError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 807, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 808, - "name": "originalError", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 804, - "name": "AuthUnknownError" - }, - "overwrites": { - "type": "reference", - "id": 786, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 785, - "name": "AuthError.constructor" - } - }, - { - "id": 809, - "name": "originalError", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 810, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 789, - "name": "AuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [805] - }, - { - "title": "Properties", - "kind": 1024, - "children": [809, 810] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 38, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 784, - "name": "AuthError" - } - ] - }, - { - "id": 812, - "name": "CustomAuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 813, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 814, - "name": "new CustomAuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 815, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 816, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 817, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 812, - "name": "CustomAuthError" - }, - "overwrites": { - "type": "reference", - "id": 786, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 785, - "name": "AuthError.constructor" - } - }, - { - "id": 818, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "name": "AuthError.name" - } - }, - { - "id": 819, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "id": 789, - "name": "AuthError.status" - } - }, - { - "id": 820, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "signatures": [ - { - "id": 821, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 822, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 824, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 60, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 823, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 825, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [824, 823, 825] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [813] - }, - { - "title": "Properties", - "kind": 1024, - "children": [818, 819] - }, - { - "title": "Methods", - "kind": 2048, - "children": [820] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 48, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 784, - "name": "AuthError" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 827, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "id": 839, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "id": 852, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "id": 877, - "name": "AuthPKCEGrantCodeExchangeError" - }, - { - "type": "reference", - "id": 902, - "name": "AuthRetryableFetchError" - } - ] - }, - { - "id": 1, - "name": "GoTrueAdminApi", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 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": 749, - "name": "GoTrueAdminMFAApi" - } - }, - { - "id": 43, - "name": "createUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 146, - "character": 8 - } - ], - "signatures": [ - { - "id": 44, - "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": 45, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 448, - "name": "AdminUserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 372, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 67, - "name": "deleteUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 262, - "character": 8 - } - ], - "signatures": [ - { - "id": 68, - "name": "deleteUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Delete a user. Requires a `service_role` key." - }, - "parameters": [ - { - "id": 69, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user id you want to remove." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 70, - "name": "shouldSoftDelete", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema.\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": 372, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 40, - "name": "generateLink", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 112, - "character": 8 - } - ], - "signatures": [ - { - "id": 41, - "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": 42, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 593, - "name": "GenerateLinkParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 594, - "name": "GenerateLinkResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 60, - "name": "getUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 215, - "character": 8 - } - ], - "signatures": [ - { - "id": 61, - "name": "getUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get user by id." - }, - "parameters": [ - { - "id": 62, - "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": 372, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 33, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 82, - "character": 8 - } - ], - "signatures": [ - { - "id": 34, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 35, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 39, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata\n" - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 86, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 38, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 85, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [39, 38] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 372, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 46, - "name": "listUsers", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 168, - "character": 8 - } - ], - "signatures": [ - { - "id": 47, - "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": 48, - "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": 774, - "name": "PageParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 49, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 50, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 171, - "character": 8 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 51, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 53, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 171, - "character": 31 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 52, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 171, - "character": 16 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 420, - "name": "User" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [53, 52] - } - ] - } - }, - { - "type": "reference", - "id": 767, - "name": "Pagination" - } - ] - } - }, - { - "id": 54, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 171, - "character": 59 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [50, 54] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 55, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 56, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 172, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 57, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 58, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 172, - "character": 16 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [58] - } - ] - } - } - }, - { - "id": 59, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 172, - "character": 29 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [56, 59] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 27, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 59, - "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.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 30, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 31, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 59, - "character": 40 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 32, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 59, - "character": 52 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 784, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [31, 32] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 63, - "name": "updateUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 237, - "character": 8 - } - ], - "signatures": [ - { - "id": 64, - "name": "updateUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates the user data." - }, - "parameters": [ - { - "id": 65, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 66, - "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": 448, - "name": "AdminUserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 372, - "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": [43, 67, 40, 60, 33, 46, 27, 63] - } - ], - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 25, - "character": 21 - } - ] - }, - { - "id": 77, - "name": "GoTrueClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 78, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 144, - "character": 2 - } - ], - "signatures": [ - { - "id": 79, - "name": "new GoTrueClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Create a new client for use in the browser." - }, - "parameters": [ - { - "id": 80, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 323, - "name": "GoTrueClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 77, - "name": "default" - } - } - ] - }, - { - "id": 81, - "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": 97, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - }, - { - "id": 82, - "name": "mfa", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Namespace for the MFA methods." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 704, - "name": "GoTrueMFAApi" - } - }, - { - "id": 121, - "name": "exchangeCodeForSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 410, - "character": 8 - } - ], - "signatures": [ - { - "id": 122, - "name": "exchangeCodeForSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user via a third-party provider." - }, - "parameters": [ - { - "id": 123, - "name": "authCode", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 337, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 136, - "name": "getSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 625, - "character": 8 - } - ], - "signatures": [ - { - "id": 137, - "name": "getSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 139, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 627, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 628, - "character": 10 - } - ], - "type": { - "type": "reference", - "id": 383, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 630, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [139, 142] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 144, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 633, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 145, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 146, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 634, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [146] - } - ] - } - } - }, - { - "id": 147, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 636, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [144, 147] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 148, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 149, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 639, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 150, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 151, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 640, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [151] - } - ] - } - } - }, - { - "id": 152, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 642, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [149, 152] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 153, - "name": "getUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 688, - "character": 8 - } - ], - "signatures": [ - { - "id": 154, - "name": "getUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the current user details if there is an existing session." - }, - "parameters": [ - { - "id": 155, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 372, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 108, - "name": "initialize", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 196, - "character": 2 - } - ], - "signatures": [ - { - "id": 109, - "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": 757, - "name": "InitializeResult" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 203, - "name": "onAuthStateChange", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1000, - "character": 2 - } - ], - "signatures": [ - { - "id": 204, - "name": "onAuthStateChange", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Receive a notification every time an auth event happens." - }, - "parameters": [ - { - "id": 205, - "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": 206, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 207, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 208, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 322, - "name": "AuthChangeEvent" - } - }, - { - "id": 209, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 383, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 210, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 211, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1001, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 213, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1001, - "character": 12 - } - ], - "type": { - "type": "reference", - "id": 457, - "name": "Subscription" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [213] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [211] - } - ] - } - } - } - ] - }, - { - "id": 175, - "name": "refreshSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 834, - "character": 8 - } - ], - "signatures": [ - { - "id": 176, - "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": 177, - "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": 178, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 179, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 834, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [179] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 337, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 217, - "name": "resetPasswordForEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1040, - "character": 8 - } - ], - "signatures": [ - { - "id": 218, - "name": "resetPasswordForEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a password reset request to an email address." - }, - "parameters": [ - { - "id": 219, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 220, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 223, - "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": 1044, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 222, - "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": 1043, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [223, 222] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 225, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1048, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 226, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 227, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1049, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [225, 227] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 228, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 229, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1051, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 230, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1051, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [229, 230] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 169, - "name": "setSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 770, - "character": 8 - } - ], - "signatures": [ - { - "id": 170, - "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": 171, - "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": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 173, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 771, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 174, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 772, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [173, 174] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 337, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 124, - "name": "signInWithIdToken", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 440, - "character": 8 - } - ], - "signatures": [ - { - "id": 125, - "name": "signInWithIdToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Allows signing in with an ID token issued by certain supported providers.\nThe ID token is verified for validity and a new session is established.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 126, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 528, - "name": "SignInWithIdTokenCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 337, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 118, - "name": "signInWithOAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 396, - "character": 8 - } - ], - "signatures": [ - { - "id": 119, - "name": "signInWithOAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user via a third-party provider." - }, - "parameters": [ - { - "id": 120, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 516, - "name": "SignInWithOAuthCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 350, - "name": "OAuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 127, - "name": "signInWithOtp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 488, - "character": 8 - } - ], - "signatures": [ - { - "id": 128, - "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.\n" - }, - "parameters": [ - { - "id": 129, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 498, - "name": "SignInWithPasswordlessCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 337, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 115, - "name": "signInWithPassword", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 346, - "character": 8 - } - ], - "signatures": [ - { - "id": 116, - "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": 117, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 484, - "name": "SignInWithPasswordCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 337, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 133, - "name": "signInWithSSO", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 596, - "character": 8 - } - ], - "signatures": [ - { - "id": 134, - "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": 135, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "name": "SignInWithSSO" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 363, - "name": "SSOResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 199, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 974, - "character": 8 - } - ], - "signatures": [ - { - "id": 200, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 202, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 974, - "character": 29 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 784, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [202] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 112, - "name": "signUp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 267, - "character": 8 - } - ], - "signatures": [ - { - "id": 113, - "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.\n", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" - }, - "parameters": [ - { - "id": 114, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 467, - "name": "SignUpWithPasswordCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 337, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 279, - "name": "startAutoRefresh", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1346, - "character": 8 - } - ], - "signatures": [ - { - "id": 280, - "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 desireable. 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": 281, - "name": "stopAutoRefresh", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 1359, - "character": 8 - } - ], - "signatures": [ - { - "id": 282, - "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": 156, - "name": "updateUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 717, - "character": 8 - } - ], - "signatures": [ - { - "id": 157, - "name": "updateUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates user data for a logged in user." - }, - "parameters": [ - { - "id": 158, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 443, - "name": "UserAttributes" - } - }, - { - "id": 159, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 160, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 161, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 720, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [161] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 372, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 130, - "name": "verifyOtp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 543, - "character": 8 - } - ], - "signatures": [ - { - "id": 131, - "name": "verifyOtp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in a user given a User supplied OTP received via mobile." - }, - "parameters": [ - { - "id": 132, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "name": "VerifyOtpParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 337, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [78] - }, - { - "title": "Properties", - "kind": 1024, - "children": [81, 82] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 121, 136, 153, 108, 203, 175, 217, 169, 124, 118, 127, 115, 133, 199, 112, 279, 281, - 156, 130 - ] - } - ], - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 92, - "character": 21 - } - ] - }, - { - "id": 392, - "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": 393, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Authentication method name." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 160, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 394, - "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": 166, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [393, 394] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 158, - "character": 17 - } - ] - }, - { - "id": 448, - "name": "AdminUserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 450, - "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": 288, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 453, - "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": 314, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 455, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 246, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.email" - } - }, - { - "id": 451, - "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": 295, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 454, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 256, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.password" - } - }, - { - "id": 456, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 251, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.phone" - } - }, - { - "id": 452, - "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": 302, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 449, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "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": 278, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 267, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 443, - "name": "UserAttributes" - }, - { - "type": "literal", - "value": "data" - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" - } - ] - }, - { - "id": 406, - "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": 411, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 204, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 409, - "name": "factor_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of factor. Only `totp` supported with this version but may change in\nfuture versions." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 199, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 408, - "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": 193, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 190, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 410, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Factor's status." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 202, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "verified" - }, - { - "type": "literal", - "value": "unverified" - } - ] - } - }, - { - "id": 412, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 205, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [411, 409, 408, 407, 410, 412] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 188, - "character": 17 - } - ] - }, - { - "id": 590, - "name": "GenerateLinkOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 591, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 570, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 592, - "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": 572, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [591, 592] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 564, - "character": 17 - } - ] - }, - { - "id": 749, - "name": "GoTrueAdminMFAApi", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "children": [ - { - "id": 753, - "name": "deleteFactor", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 754, - "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": 755, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 733, - "name": "AuthMFAAdminDeleteFactorParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 724, - "name": "AuthMFAAdminDeleteFactorResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 750, - "name": "listFactors", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 751, - "name": "listFactors", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Lists all factors associated to a user." - }, - "parameters": [ - { - "id": 752, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 746, - "name": "AuthMFAAdminListFactorsParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 737, - "name": "AuthMFAAdminListFactorsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "kind": 2048, - "children": [753, 750] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 902, - "character": 17 - } - ] - }, - { - "id": 704, - "name": "GoTrueMFAApi", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "Contains the full multi-factor authentication API." - }, - "children": [ - { - "id": 708, - "name": "challenge", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 709, - "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": 710, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 628, - "name": "MFAChallengeParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 672, - "name": "AuthMFAChallengeResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 717, - "name": "challengeAndVerify", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 718, - "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": 719, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 631, - "name": "MFAChallengeAndVerifyParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 635, - "name": "AuthMFAVerifyResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 705, - "name": "enroll", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 706, - "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": 707, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 615, - "name": "MFAEnrollParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 648, - "name": "AuthMFAEnrollResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 722, - "name": "getAuthenticatorAssuranceLevel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 723, - "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": 693, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 720, - "name": "listFactors", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 721, - "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": 682, - "name": "AuthMFAListFactorsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 714, - "name": "unenroll", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 715, - "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": 716, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 620, - "name": "MFAUnenrollParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 663, - "name": "AuthMFAUnenrollResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 711, - "name": "verify", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 712, - "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": 713, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 623, - "name": "MFAVerifyParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 635, - "name": "AuthMFAVerifyResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "kind": 2048, - "children": [708, 717, 705, 722, 720, 714, 711] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 789, - "character": 17 - } - ] - }, - { - "id": 383, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 386, - "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": 133, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 389, - "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": 145, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 388, - "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": 141, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 385, - "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": 129, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 384, - "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": 124, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 387, - "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": 137, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 390, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 146, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 391, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 147, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 420, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [386, 389, 388, 385, 384, 387, 390, 391] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 120, - "character": 17 - } - ] - }, - { - "id": 457, - "name": "Subscription", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 458, - "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": 321, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 459, - "name": "callback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 325, - "character": 2 - } - ], - "signatures": [ - { - "id": 460, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ - { - "id": 461, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 322, - "name": "AuthChangeEvent" - } - }, - { - "id": 462, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 383, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 463, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 329, - "character": 2 - } - ], - "signatures": [ - { - "id": 464, - "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": [458] - }, - { - "title": "Methods", - "kind": 2048, - "children": [459, 463] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 317, - "character": 17 - } - ] - }, - { - "id": 465, - "name": "UpdatableFactorAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 466, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 333, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [466] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 332, - "character": 17 - } - ] - }, - { - "id": 420, - "name": "User", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 431, - "name": "action_link", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 228, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 219, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 413, - "name": "UserAppMetadata" - } - }, - { - "id": 424, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 221, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 425, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 222, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 232, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 231, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 432, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 229, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 427, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 224, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 436, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 233, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 239, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 406, - "name": "Factor" - } - } - }, - { - "id": 421, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 218, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 238, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 395, - "name": "UserIdentity" - } - } - }, - { - "id": 430, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 227, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 438, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 235, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 428, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 225, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 429, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 226, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 433, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 230, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 437, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 234, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 426, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 223, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 439, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 236, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 440, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 237, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 423, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 220, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 417, - "name": "UserMetadata" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 431, 422, 424, 425, 435, 434, 432, 427, 436, 442, 421, 441, 430, 438, 428, 429, 433, - 437, 426, 439, 440, 423 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 217, - "character": 17 - } - ] - }, - { - "id": 413, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 414, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [414] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 208, - "character": 17 - } - ], - "indexSignature": { - "id": 415, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 416, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "id": 443, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 447, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 444, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 246, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 446, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 256, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 445, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 251, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [447, 444, 446, 445] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 242, - "character": 17 - } - ] - }, - { - "id": 395, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 403, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 176, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 396, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 170, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 398, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 172, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 399, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 400, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 401, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 404, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 177, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 402, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 175, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 178, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 397, - "name": "user_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 171, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [403, 396, 398, 404, 402, 405, 397] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 169, - "character": 17 - } - ] - }, - { - "id": 417, - "name": "UserMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 213, - "character": 17 - } - ], - "indexSignature": { - "id": 418, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 419, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "id": 545, - "name": "VerifyEmailOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 546, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 492, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 549, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 497, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 550, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 552, - "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": 501, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 551, - "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": 499, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [552, 551] - } - ] - } - } - }, - { - "id": 547, - "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": 494, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 548, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 496, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 554, - "name": "EmailOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [546, 549, 547, 548] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 490, - "character": 17 - } - ] - }, - { - "id": 537, - "name": "VerifyMobileOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 541, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 478, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 542, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 544, - "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": 487, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 543, - "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": 480, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [544, 543] - } - ] - } - } - }, - { - "id": 538, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 473, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 539, - "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": 475, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 477, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 553, - "name": "MobileOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [541, 538, 539, 540] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 471, - "character": 17 - } - ] - }, - { - "id": 322, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 25, - "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" - }, - { - "type": "reference", - "id": 321, - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "id": 321, - "name": "AuthChangeEventMFA", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 515, - "name": "AuthFlowType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 439, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - } - ] - } - }, - { - "id": 733, - "name": "AuthMFAAdminDeleteFactorParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 868, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 734, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 735, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the MFA factor to delete." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 870, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 736, - "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": 873, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [735, 736] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 868, - "character": 45 - } - ] - } - } - }, - { - "id": 724, - "name": "AuthMFAAdminDeleteFactorResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 855, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 725, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 726, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 727, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 728, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 859, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [728] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 12 - } - ] - } - } - }, - { - "id": 729, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 861, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [726, 729] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 856, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 730, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 731, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 863, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 732, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 863, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [731, 732] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 863, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 746, - "name": "AuthMFAAdminListFactorsParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 892, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 747, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 748, - "name": "userId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 894, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [748] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 892, - "character": 44 - } - ] - } - } - }, - { - "id": 737, - "name": "AuthMFAAdminListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 879, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 738, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 739, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 881, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 740, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 741, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All factors attached to the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 883, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 406, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [741] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 881, - "character": 12 - } - ] - } - } - }, - { - "id": 742, - "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": [739, 742] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 880, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 743, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 744, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 887, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 745, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 887, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [744, 745] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 887, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 672, - "name": "AuthMFAChallengeResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 732, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 673, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 674, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 734, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 675, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 677, - "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": 739, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 676, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the newly created challenge." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 736, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [677, 676] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 734, - "character": 12 - } - ] - } - } - }, - { - "id": 678, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 741, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [674, 678] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 733, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 679, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 680, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 743, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 681, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 743, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [680, 681] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 743, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 648, - "name": "AuthMFAEnrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 689, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 650, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 691, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 651, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 652, - "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": 693, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "TOTP enrollment information." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 699, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 655, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 656, - "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": 703, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 657, - "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": 708, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "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": 712, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [656, 657, 658] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 699, - "character": 14 - } - ] - } - } - }, - { - "id": 653, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of MFA factor. Only `totp` supported for now." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 696, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [652, 654, 653] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 691, - "character": 12 - } - ] - } - } - }, - { - "id": 659, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 715, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [650, 659] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 690, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 660, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 661, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 718, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 662, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 719, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [661, 662] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 717, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 693, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 760, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 694, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 695, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 762, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 696, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 699, - "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": 779, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 392, - "name": "AMREntry" - } - } - }, - { - "id": 697, - "name": "currentLevel", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Current AAL level of the session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 764, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 692, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 698, - "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": 772, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 692, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [699, 697, 698] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 762, - "character": 12 - } - ] - } - } - }, - { - "id": 700, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 781, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [695, 700] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 761, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 701, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 702, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 783, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 703, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 783, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [702, 703] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 783, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 682, - "name": "AuthMFAListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 745, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 684, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 747, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 685, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 686, - "name": "all", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All available factors (verified and unverified)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 749, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 406, - "name": "Factor" - } - } - }, - { - "id": 687, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 752, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 406, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [686, 687] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 747, - "character": 12 - } - ] - } - } - }, - { - "id": 688, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 754, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [684, 688] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 746, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 689, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 690, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 756, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 691, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 756, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [690, 691] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 756, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 663, - "name": "AuthMFAUnenrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 722, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 664, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 665, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 724, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 666, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 667, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 726, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [667] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 724, - "character": 12 - } - ] - } - } - }, - { - "id": 668, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 728, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [665, 668] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 723, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 669, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 670, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 671, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [670, 671] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 635, - "name": "AuthMFAVerifyResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 664, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 636, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 637, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 666, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 638, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 639, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "New access token (JWT) after successful verification." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 668, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 641, - "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": 674, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 642, - "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": 677, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 640, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of token, typically `Bearer`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 671, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 643, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Updated user profile." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 680, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 420, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [639, 641, 642, 640, 643] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 666, - "character": 12 - } - ] - } - } - }, - { - "id": 644, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 682, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [637, 644] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 665, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 645, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 646, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 685, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 647, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 686, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [646, 647] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 684, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 337, - "name": "AuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 55, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "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/lib/types.ts", - "line": 57, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 340, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 342, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 383, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 341, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 420, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [342, 341] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 12 - } - ] - } - } - }, - { - "id": 343, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [339, 343] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 344, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 345, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 346, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 348, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 66, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 347, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 65, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [348, 347] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 12 - } - ] - } - } - }, - { - "id": 349, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 68, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [345, 349] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 692, - "name": "AuthenticatorAssuranceLevels", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 758, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - } - ] - } - }, - { - "id": 760, - "name": "CallRefreshTokenResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 933, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 761, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 763, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 936, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 762, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 935, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 383, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [763, 762] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 934, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 764, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 766, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 940, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - }, - { - "id": 765, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 939, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [766, 765] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 938, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 554, - "name": "EmailOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 506, - "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": 584, - "name": "GenerateEmailChangeLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 553, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 585, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 587, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 556, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 588, - "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": 560, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 589, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 561, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 590, - "name": "GenerateLinkOptions" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 586, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 554, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [587, 588, 589, 586] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 553, - "character": 44 - } - ] - } - } - }, - { - "id": 574, - "name": "GenerateInviteOrMagiclinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 539, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 575, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 577, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 542, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 578, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 543, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 590, - "name": "GenerateLinkOptions" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 576, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 540, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [577, 578, 576] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 539, - "character": 46 - } - ] - } - } - }, - { - "id": 593, - "name": "GenerateLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 575, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 568, - "name": "GenerateSignupLinkParams" - }, - { - "type": "reference", - "id": 574, - "name": "GenerateInviteOrMagiclinkParams" - }, - { - "type": "reference", - "id": 579, - "name": "GenerateRecoveryLinkParams" - }, - { - "type": "reference", - "id": 584, - "name": "GenerateEmailChangeLinkParams" - } - ] - } - }, - { - "id": 607, - "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": 598, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 608, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 609, - "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": 603, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 610, - "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": 608, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 611, - "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": 612, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 612, - "name": "redirect_to", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The URL appended to the action link." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 614, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 613, - "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": 616, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 614, - "name": "GenerateLinkType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [609, 610, 611, 612, 613] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 598, - "character": 37 - } - ] - } - } - }, - { - "id": 594, - "name": "GenerateLinkResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 581, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 595, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 596, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 583, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 597, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 598, - "name": "properties", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 584, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 607, - "name": "GenerateLinkProperties" - } - }, - { - "id": 599, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 585, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 420, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [598, 599] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 583, - "character": 12 - } - ] - } - } - }, - { - "id": 600, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 587, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [596, 600] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 582, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 601, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 602, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 590, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 603, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 604, - "name": "properties", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 591, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 605, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 592, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [604, 605] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 590, - "character": 12 - } - ] - } - } - }, - { - "id": 606, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 594, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [602, 606] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 589, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 614, - "name": "GenerateLinkType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 619, - "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": 579, - "name": "GenerateRecoveryLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 546, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 580, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 582, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 549, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 583, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 550, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 590, - "name": "GenerateLinkOptions" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 581, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 547, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [582, 583, 581] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 546, - "character": 41 - } - ] - } - } - }, - { - "id": 568, - "name": "GenerateSignupLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 532, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 569, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 571, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 534, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 573, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 536, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 590, - "name": "GenerateLinkOptions" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 572, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 535, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 570, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 533, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [571, 573, 572, 570] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 532, - "character": 39 - } - ] - } - } - }, - { - "id": 323, - "name": "GoTrueClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 324, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 332, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 331, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 335, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 336, - "name": "flowType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 52, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 515, - "name": "AuthFlowType" - } - }, - { - "id": 326, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 327, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 38, - "character": 12 - } - ], - "indexSignature": { - "id": 328, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 329, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 333, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 46, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 334, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 756, - "name": "SupportedStorage" - } - }, - { - "id": 330, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 325, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [332, 331, 335, 336, 326, 333, 334, 330, 325] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 34 - } - ] - } - } - }, - { - "id": 757, - "name": "InitializeResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 931, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 758, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 759, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 931, - "character": 33 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 784, - "name": "AuthError" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [759] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 931, - "character": 31 - } - ] - } - } - }, - { - "id": 631, - "name": "MFAChallengeAndVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 657, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 632, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 634, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 661, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 633, - "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": 659, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [634, 633] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 657, - "character": 42 - } - ] - } - } - }, - { - "id": 628, - "name": "MFAChallengeParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 652, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 629, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 630, - "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": 654, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [630] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 652, - "character": 33 - } - ] - } - } - }, - { - "id": 615, - "name": "MFAEnrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 627, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 616, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 617, - "name": "factorType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of factor being enrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 629, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - }, - { - "id": 619, - "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": 633, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 618, - "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": 631, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [617, 619, 618] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 627, - "character": 30 - } - ] - } - } - }, - { - "id": 620, - "name": "MFAUnenrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 636, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 621, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 622, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 638, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [622] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 636, - "character": 32 - } - ] - } - } - }, - { - "id": 623, - "name": "MFAVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 641, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 624, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 626, - "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": 646, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 627, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 649, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 625, - "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": 643, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [626, 627, 625] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 641, - "character": 30 - } - ] - } - } - }, - { - "id": 553, - "name": "MobileOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 505, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - }, - { - "id": 350, - "name": "OAuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 351, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 352, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 353, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 354, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 74, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 320, - "name": "Provider" - } - }, - { - "id": 355, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 75, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [354, 355] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 12 - } - ] - } - } - }, - { - "id": 356, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 77, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [352, 356] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 357, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 358, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 81, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 320, - "name": "Provider" - } - }, - { - "id": 361, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [360, 361] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 12 - } - ] - } - } - }, - { - "id": 362, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 84, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [358, 362] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 774, - "name": "PageParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 950, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 775, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 776, - "name": "page", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The page number" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 952, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 777, - "name": "perPage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Number of items returned per page" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 954, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [776, 777] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 950, - "character": 25 - } - ] - } - } - }, - { - "id": 767, - "name": "Pagination", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 768, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 770, - "name": "lastPage", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 946, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 769, - "name": "nextPage", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 945, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 771, - "name": "total", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 947, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [770, 769, 771] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 25 - } - ], - "indexSignature": { - "id": 772, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 773, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 320, - "name": "Provider", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 5, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "workos" - } - ] - } - }, - { - "id": 363, - "name": "SSOResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 87, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 364, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 89, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 366, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 367, - "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": 97, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [367] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 89, - "character": 12 - } - ] - } - } - }, - { - "id": 368, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365, 368] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 88, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 369, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 370, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 371, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 103, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [370, 371] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 528, - "name": "SignInWithIdTokenCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 455, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 529, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 532, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If the ID token contains a `nonce`, then the hash of this value is compared to the value in the ID token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 463, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 533, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 464, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 534, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 535, - "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": 466, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [535] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 464, - "character": 12 - } - ] - } - } - }, - { - "id": 530, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Only Apple and Google ID tokens are supported for use from within iOS or Android applications." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 459, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - } - ] - } - }, - { - "id": 531, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID token issued by Apple or Google." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 461, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [532, 533, 530, 531] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 455, - "character": 43 - } - ] - } - } - }, - { - "id": 516, - "name": "SignInWithOAuthCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 440, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 517, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 519, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 443, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 520, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 523, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An object of query params" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 449, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 524, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 449, - "character": 18 - } - ], - "indexSignature": { - "id": 525, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 526, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 521, - "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": 445, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 522, - "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": 447, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 527, - "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": 451, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [523, 521, 522, 527] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 443, - "character": 12 - } - ] - } - } - }, - { - "id": 518, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 442, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 320, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [519, 518] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 440, - "character": 41 - } - ] - } - } - }, - { - "id": 484, - "name": "SignInWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 373, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 485, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 486, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 376, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 488, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 379, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 489, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 490, - "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": 381, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [490] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 379, - "character": 16 - } - ] - } - } - }, - { - "id": 487, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 378, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [486, 488, 487] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 374, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 491, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 494, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 389, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 495, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 497, - "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": 397, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 496, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 395, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [497, 496] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 389, - "character": 16 - } - ] - } - } - }, - { - "id": 493, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 388, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 492, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 386, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [494, 493, 492] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 384, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 498, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 401, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 499, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 500, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 501, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 405, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 502, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 506, - "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": 417, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 505, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 415, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 503, - "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": 407, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 504, - "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": 409, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [506, 505, 503, 504] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 405, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [500, 501] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 402, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 507, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 509, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 423, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 513, - "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": 433, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 514, - "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": 435, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 512, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 431, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 511, - "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": 425, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [513, 514, 512, 511] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 423, - "character": 16 - } - ] - } - } - }, - { - "id": 508, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 422, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [509, 508] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 420, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 555, - "name": "SignInWithSSO", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 508, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 558, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 513, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 559, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 561, - "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": 517, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 560, - "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": 515, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [561, 560] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 513, - "character": 16 - } - ] - } - } - }, - { - "id": 557, - "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": 511, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [558, 557] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 509, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 562, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 563, - "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": 522, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 564, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 524, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 565, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 567, - "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": 528, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 566, - "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": 526, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [567, 566] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 524, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [563, 564] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 467, - "name": "SignUpWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 336, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 469, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 471, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 472, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 475, - "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": 352, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 474, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 473, - "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": 344, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [475, 474, 473] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 16 - } - ] - } - } - }, - { - "id": 470, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [469, 471, 470] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 476, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 479, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 360, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 482, - "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": 368, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 483, - "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": 370, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 481, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 366, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [482, 483, 481] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 360, - "character": 16 - } - ] - } - } - }, - { - "id": 478, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 359, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 477, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 357, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [479, 478, 477] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 355, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 756, - "name": "SupportedStorage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 929, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - ], - "name": "PromisifyMethods" - } - }, - { - "id": 372, - "name": "UserResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 106, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 373, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 374, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 376, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 420, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [376] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 12 - } - ] - } - } - }, - { - "id": 377, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [374, 377] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 378, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 379, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 114, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 380, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 381, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 115, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [381] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 114, - "character": 12 - } - ] - } - } - }, - { - "id": 382, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 117, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [379, 382] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 113, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 536, - "name": "VerifyOtpParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 470, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 537, - "name": "VerifyMobileOtpParams" - }, - { - "type": "reference", - "id": 545, - "name": "VerifyEmailOtpParams" - } - ] - } - }, - { - "id": 781, - "name": "isAuthApiError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 34, - "character": 16 - } - ], - "signatures": [ - { - "id": 782, - "name": "isAuthApiError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 783, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 791, - "name": "AuthApiError" - } - } - } - ] - }, - { - "id": 778, - "name": "isAuthError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 12, - "character": 16 - } - ], - "signatures": [ - { - "id": 779, - "name": "isAuthError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 780, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [791, 784, 852, 839, 877, 902, 827, 804, 812, 1, 77] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [392, 448, 406, 590, 749, 704, 383, 457, 465, 420, 413, 443, 395, 417, 545, 537] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [ - 322, 321, 515, 733, 724, 746, 737, 672, 648, 693, 682, 663, 635, 337, 692, 760, 554, 584, - 574, 593, 607, 594, 614, 579, 568, 323, 757, 631, 628, 615, 620, 623, 553, 350, 774, 767, - 320, 363, 528, 516, 484, 498, 555, 467, 756, 372, 536 - ] - }, - { - "title": "Functions", - "kind": 64, - "children": [781, 778] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] -} + "id": 0, + "name": "@supabase/gotrue-js", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 811, + "name": "AuthApiError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 812, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 19, + "character": 2 + } + ], + "signatures": [ + { + "id": 813, + "name": "new AuthApiError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 814, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 815, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 811, + "name": "AuthApiError" + }, + "overwrites": { + "type": "reference", + "id": 806, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 805, + "name": "AuthError.constructor" + } + }, + { + "id": 816, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 17, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "overwrites": { + "type": "reference", + "id": 809, + "name": "AuthError.status" + } + }, + { + "id": 817, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 25, + "character": 2 + } + ], + "signatures": [ + { + "id": 818, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 819, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 821, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 28, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 820, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 27, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 822, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 29, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 821, + 820, + 822 + ] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 812 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 816 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 817 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 16, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 804, + "name": "AuthError" + } + ] + }, + { + "id": 804, + "name": "AuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 805, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 5, + "character": 2 + } + ], + "signatures": [ + { + "id": 806, + "name": "new AuthError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 807, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 808, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 809, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 2, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 805 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 809 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 1, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 811, + "name": "AuthApiError" + }, + { + "type": "reference", + "id": 824, + "name": "AuthUnknownError" + }, + { + "type": "reference", + "id": 832, + "name": "CustomAuthError" + } + ] + }, + { + "id": 872, + "name": "AuthImplicitGrantRedirectError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 873, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 874, + "name": "new AuthImplicitGrantRedirectError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 875, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 876, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 877, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 879, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 80, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 878, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 80, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 879, + 878 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "id": 872, + "name": "AuthImplicitGrantRedirectError" + }, + "overwrites": { + "type": "reference", + "id": 834, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 833, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 880, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 79, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 881, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 883, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 79, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 882, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 79, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 883, + 882 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 894, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 838, + "name": "CustomAuthError.name" + } + }, + { + "id": 895, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 839, + "name": "CustomAuthError.status" + } + }, + { + "id": 884, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 85, + "character": 2 + } + ], + "signatures": [ + { + "id": 885, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 886, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 890, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 891, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 893, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 79, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 892, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 79, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 893, + 892 + ] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 888, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 88, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 887, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 87, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 889, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 890, + 888, + 887, + 889 + ] + } + ] + } + }, + "overwrites": { + "type": "reference", + "id": 841, + "name": "CustomAuthError.toJSON" + } + } + ], + "overwrites": { + "type": "reference", + "id": 840, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 873 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 880, + 894, + 895 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 884 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 78, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 832, + "name": "CustomAuthError" + } + ] + }, + { + "id": 859, + "name": "AuthInvalidCredentialsError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 860, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 2 + } + ], + "signatures": [ + { + "id": 861, + "name": "new AuthInvalidCredentialsError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 862, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 859, + "name": "AuthInvalidCredentialsError" + }, + "overwrites": { + "type": "reference", + "id": 834, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 833, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 863, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 838, + "name": "CustomAuthError.name" + } + }, + { + "id": 864, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 839, + "name": "CustomAuthError.status" + } + }, + { + "id": 865, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "signatures": [ + { + "id": 866, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 867, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 869, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 60, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 868, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 870, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 61, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 869, + 868, + 870 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 841, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 840, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 860 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 863, + 864 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 865 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 72, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 832, + "name": "CustomAuthError" + } + ] + }, + { + "id": 897, + "name": "AuthPKCEGrantCodeExchangeError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 898, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 97, + "character": 2 + } + ], + "signatures": [ + { + "id": 899, + "name": "new AuthPKCEGrantCodeExchangeError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 900, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 901, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 902, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 904, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 97, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 903, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 97, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 904, + 903 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "id": 897, + "name": "AuthPKCEGrantCodeExchangeError" + }, + "overwrites": { + "type": "reference", + "id": 834, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 833, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 905, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 96, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 906, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 908, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 96, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 907, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 96, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 908, + 907 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 919, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 838, + "name": "CustomAuthError.name" + } + }, + { + "id": 920, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 839, + "name": "CustomAuthError.status" + } + }, + { + "id": 909, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 102, + "character": 2 + } + ], + "signatures": [ + { + "id": 910, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 911, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 915, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 107, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 916, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 918, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 96, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 917, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 96, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 918, + 917 + ] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 913, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 105, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 912, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 104, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 914, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 106, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 915, + 913, + 912, + 914 + ] + } + ] + } + }, + "overwrites": { + "type": "reference", + "id": 841, + "name": "CustomAuthError.toJSON" + } + } + ], + "overwrites": { + "type": "reference", + "id": 840, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 898 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 905, + 919, + 920 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 909 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 95, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 832, + "name": "CustomAuthError" + } + ] + }, + { + "id": 922, + "name": "AuthRetryableFetchError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 923, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 113, + "character": 2 + } + ], + "signatures": [ + { + "id": 924, + "name": "new AuthRetryableFetchError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 925, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 926, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 922, + "name": "AuthRetryableFetchError" + }, + "overwrites": { + "type": "reference", + "id": 834, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 833, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 927, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 838, + "name": "CustomAuthError.name" + } + }, + { + "id": 928, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 839, + "name": "CustomAuthError.status" + } + }, + { + "id": 929, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "signatures": [ + { + "id": 930, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 931, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 933, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 60, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 932, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 934, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 61, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 933, + 932, + 934 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 841, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 840, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 923 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 927, + 928 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 929 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 832, + "name": "CustomAuthError" + } + ] + }, + { + "id": 847, + "name": "AuthSessionMissingError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 848, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 67, + "character": 2 + } + ], + "signatures": [ + { + "id": 849, + "name": "new AuthSessionMissingError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 847, + "name": "AuthSessionMissingError" + }, + "overwrites": { + "type": "reference", + "id": 834, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 833, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 850, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 838, + "name": "CustomAuthError.name" + } + }, + { + "id": 851, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 839, + "name": "CustomAuthError.status" + } + }, + { + "id": 852, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "signatures": [ + { + "id": 853, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 854, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 856, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 60, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 855, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 857, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 61, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 856, + 855, + 857 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 841, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 840, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 848 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 850, + 851 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 852 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 66, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 832, + "name": "CustomAuthError" + } + ] + }, + { + "id": 824, + "name": "AuthUnknownError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 825, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 41, + "character": 2 + } + ], + "signatures": [ + { + "id": 826, + "name": "new AuthUnknownError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 827, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 828, + "name": "originalError", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 824, + "name": "AuthUnknownError" + }, + "overwrites": { + "type": "reference", + "id": 806, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 805, + "name": "AuthError.constructor" + } + }, + { + "id": 829, + "name": "originalError", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 830, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 2, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 809, + "name": "AuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 825 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 829, + 830 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 38, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 804, + "name": "AuthError" + } + ] + }, + { + "id": 832, + "name": "CustomAuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 833, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 834, + "name": "new CustomAuthError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 835, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 836, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 837, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 832, + "name": "CustomAuthError" + }, + "overwrites": { + "type": "reference", + "id": 806, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 805, + "name": "AuthError.constructor" + } + }, + { + "id": 838, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "name": "AuthError.name" + } + }, + { + "id": 839, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "overwrites": { + "type": "reference", + "id": 809, + "name": "AuthError.status" + } + }, + { + "id": 840, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2 + } + ], + "signatures": [ + { + "id": 841, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 842, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 844, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 60, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 843, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 845, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 61, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 844, + 843, + 845 + ] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 833 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 838, + 839 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 840 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 48, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 804, + "name": "AuthError" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 847, + "name": "AuthSessionMissingError" + }, + { + "type": "reference", + "id": 859, + "name": "AuthInvalidCredentialsError" + }, + { + "type": "reference", + "id": 872, + "name": "AuthImplicitGrantRedirectError" + }, + { + "type": "reference", + "id": 897, + "name": "AuthPKCEGrantCodeExchangeError" + }, + { + "type": "reference", + "id": 922, + "name": "AuthRetryableFetchError" + } + ] + }, + { + "id": 1, + "name": "GoTrueAdminApi", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 2, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 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": 769, + "name": "GoTrueAdminMFAApi" + } + }, + { + "id": 43, + "name": "createUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 148, + "character": 8 + } + ], + "signatures": [ + { + "id": 44, + "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": 45, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 454, + "name": "AdminUserAttributes" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 377, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 67, + "name": "deleteUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 264, + "character": 8 + } + ], + "signatures": [ + { + "id": 68, + "name": "deleteUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Delete a user. Requires a `service_role` key." + }, + "parameters": [ + { + "id": 69, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The user id you want to remove." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 70, + "name": "shouldSoftDelete", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "If true, then the user will be soft-deleted from the auth schema.\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": 377, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 40, + "name": "generateLink", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 114, + "character": 8 + } + ], + "signatures": [ + { + "id": 41, + "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": 42, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 613, + "name": "GenerateLinkParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 614, + "name": "GenerateLinkResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 60, + "name": "getUserById", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 217, + "character": 8 + } + ], + "signatures": [ + { + "id": 61, + "name": "getUserById", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get user by id." + }, + "parameters": [ + { + "id": 62, + "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": 377, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 33, + "name": "inviteUserByEmail", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 81, + "character": 8 + } + ], + "signatures": [ + { + "id": 34, + "name": "inviteUserByEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends an invite link to an email address." + }, + "parameters": [ + { + "id": 35, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The email address of the user." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 36, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Additional options to be included when inviting.\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 37, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 38, + "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": 85, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 39, + "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": 88, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 38, + 39 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 377, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 46, + "name": "listUsers", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 170, + "character": 8 + } + ], + "signatures": [ + { + "id": 47, + "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": 48, + "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": 794, + "name": "PageParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 49, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 50, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 173, + "character": 8 + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 51, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 53, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 173, + "character": 31 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 52, + "name": "users", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 173, + "character": 16 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 425, + "name": "User" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 53, + 52 + ] + } + ] + } + }, + { + "type": "reference", + "id": 787, + "name": "Pagination" + } + ] + } + }, + { + "id": 54, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 173, + "character": 59 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 50, + 54 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 55, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 56, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 174, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 57, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 58, + "name": "users", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 174, + "character": 16 + } + ], + "type": { + "type": "tuple" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 58 + ] + } + ] + } + } + }, + { + "id": 59, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 174, + "character": 29 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 56, + 59 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 27, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 59, + "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.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 30, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 31, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 59, + "character": 40 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 32, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 59, + "character": 52 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 804, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 31, + 32 + ] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 63, + "name": "updateUserById", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 239, + "character": 8 + } + ], + "signatures": [ + { + "id": 64, + "name": "updateUserById", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates the user data." + }, + "parameters": [ + { + "id": 65, + "name": "uid", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 66, + "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": 454, + "name": "AdminUserAttributes" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 377, + "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": [ + 43, + 67, + 40, + 60, + 33, + 46, + 27, + 63 + ] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 25, + "character": 21 + } + ] + }, + { + "id": 77, + "name": "GoTrueClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 78, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 145, + "character": 2 + } + ], + "signatures": [ + { + "id": 79, + "name": "new GoTrueClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Create a new client for use in the browser." + }, + "parameters": [ + { + "id": 80, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 328, + "name": "GoTrueClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 77, + "name": "default" + } + } + ] + }, + { + "id": 81, + "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": 98, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + }, + { + "id": 82, + "name": "mfa", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Namespace for the MFA methods." + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 102, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 724, + "name": "GoTrueMFAApi" + } + }, + { + "id": 121, + "name": "exchangeCodeForSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 411, + "character": 8 + } + ], + "signatures": [ + { + "id": 122, + "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": 123, + "name": "authCode", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 141, + "name": "getSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 693, + "character": 8 + } + ], + "signatures": [ + { + "id": 142, + "name": "getSession", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 143, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 144, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 695, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 145, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 146, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 696, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 388, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 146 + ] + } + ] + } + } + }, + { + "id": 147, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 698, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 144, + 147 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 148, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 149, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 701, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 150, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 151, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 702, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 151 + ] + } + ] + } + } + }, + { + "id": 152, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 704, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 149, + 152 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 153, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 154, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 707, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 156, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 708, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 156 + ] + } + ] + } + } + }, + { + "id": 157, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 710, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 154, + 157 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 158, + "name": "getUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 756, + "character": 8 + } + ], + "signatures": [ + { + "id": 159, + "name": "getUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Gets the current user details if there is an existing session." + }, + "parameters": [ + { + "id": 160, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 377, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 108, + "name": "initialize", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 197, + "character": 2 + } + ], + "signatures": [ + { + "id": 109, + "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": 777, + "name": "InitializeResult" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 208, + "name": "onAuthStateChange", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1071, + "character": 2 + } + ], + "signatures": [ + { + "id": 209, + "name": "onAuthStateChange", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Receive a notification every time an auth event happens." + }, + "parameters": [ + { + "id": 210, + "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": 211, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 212, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 213, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 327, + "name": "AuthChangeEvent" + } + }, + { + "id": 214, + "name": "session", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 388, + "name": "Session" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 215, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 216, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1072, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 217, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 218, + "name": "subscription", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1072, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 464, + "name": "Subscription" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 218 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 216 + ] + } + ] + } + } + } + ] + }, + { + "id": 136, + "name": "reauthenticate", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 626, + "character": 8 + } + ], + "signatures": [ + { + "id": 137, + "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": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 180, + "name": "refreshSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 902, + "character": 8 + } + ], + "signatures": [ + { + "id": 181, + "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": 182, + "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": 183, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 184, + "name": "refresh_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 902, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 184 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 138, + "name": "resend", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 651, + "character": 8 + } + ], + "signatures": [ + { + "id": 139, + "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": 140, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 562, + "name": "ResendParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 222, + "name": "resetPasswordForEmail", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1111, + "character": 8 + } + ], + "signatures": [ + { + "id": 223, + "name": "resetPasswordForEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a password reset request to an email address." + }, + "parameters": [ + { + "id": 224, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The email address of the user." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 225, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 226, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 228, + "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": 1115, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 227, + "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": 1114, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 228, + 227 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 229, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 230, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1119, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 231, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 232, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1120, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 230, + 232 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 233, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 234, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1122, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 235, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1122, + "character": 20 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 234, + 235 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 174, + "name": "setSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 838, + "character": 8 + } + ], + "signatures": [ + { + "id": 175, + "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": 176, + "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": 177, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 178, + "name": "access_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 839, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 179, + "name": "refresh_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 840, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 178, + 179 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 124, + "name": "signInWithIdToken", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 441, + "character": 8 + } + ], + "signatures": [ + { + "id": 125, + "name": "signInWithIdToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Allows signing in with an ID token issued by certain supported providers.\nThe ID token is verified for validity and a new session is established.", + "tags": [ + { + "tag": "experimental", + "text": "\n" + } + ] + }, + "parameters": [ + { + "id": 126, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 535, + "name": "SignInWithIdTokenCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 118, + "name": "signInWithOAuth", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 119, + "name": "signInWithOAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in an existing user via a third-party provider." + }, + "parameters": [ + { + "id": 120, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 523, + "name": "SignInWithOAuthCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 355, + "name": "OAuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 127, + "name": "signInWithOtp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 489, + "character": 8 + } + ], + "signatures": [ + { + "id": 128, + "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.\n" + }, + "parameters": [ + { + "id": 129, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 505, + "name": "SignInWithPasswordlessCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 115, + "name": "signInWithPassword", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 347, + "character": 8 + } + ], + "signatures": [ + { + "id": 116, + "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": 117, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 491, + "name": "SignInWithPasswordCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 133, + "name": "signInWithSSO", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 597, + "character": 8 + } + ], + "signatures": [ + { + "id": 134, + "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": 135, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 575, + "name": "SignInWithSSO" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 368, + "name": "SSOResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 204, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1045, + "character": 8 + } + ], + "signatures": [ + { + "id": 205, + "name": "signOut", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", + "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 206, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 207, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1045, + "character": 29 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 804, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 207 + ] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 112, + "name": "signUp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 268, + "character": 8 + } + ], + "signatures": [ + { + "id": 113, + "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.\n", + "returns": "A logged-in session if the server has \"autoconfirm\" ON" + }, + "parameters": [ + { + "id": 114, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 474, + "name": "SignUpWithPasswordCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 284, + "name": "startAutoRefresh", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1415, + "character": 8 + } + ], + "signatures": [ + { + "id": 285, + "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 desireable. 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": 286, + "name": "stopAutoRefresh", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1428, + "character": 8 + } + ], + "signatures": [ + { + "id": 287, + "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": 161, + "name": "updateUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 785, + "character": 8 + } + ], + "signatures": [ + { + "id": 162, + "name": "updateUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates user data for a logged in user." + }, + "parameters": [ + { + "id": 163, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 448, + "name": "UserAttributes" + } + }, + { + "id": 164, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 165, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 166, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 788, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 166 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 377, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 130, + "name": "verifyOtp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 544, + "character": 8 + } + ], + "signatures": [ + { + "id": 131, + "name": "verifyOtp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in a user given a User supplied OTP received via mobile." + }, + "parameters": [ + { + "id": 132, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 543, + "name": "VerifyOtpParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 78 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 81, + 82 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 121, + 141, + 158, + 108, + 208, + 136, + 180, + 138, + 222, + 174, + 124, + 118, + 127, + 115, + 133, + 204, + 112, + 284, + 286, + 161, + 130 + ] + } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 93, + "character": 21 + } + ] + }, + { + "id": 397, + "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": 398, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Authentication method name." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 161, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 399, + "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": 167, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 398, + 399 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 159, + "character": 17 + } + ] + }, + { + "id": 454, + "name": "AdminUserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 456, + "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": 296, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 459, + "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": 322, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 462, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 247, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.email" + } + }, + { + "id": 457, + "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": 303, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 257, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.password" + } + }, + { + "id": 463, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 252, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.phone" + } + }, + { + "id": 458, + "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": 310, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 455, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "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": 286, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 275, + "character": 17 + } + ], + "extendedTypes": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 448, + "name": "UserAttributes" + }, + { + "type": "literal", + "value": "data" + } + ], + "qualifiedName": "Omit", + "package": "typescript", + "name": "Omit" + } + ] + }, + { + "id": 411, + "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": 416, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 205, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 414, + "name": "factor_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of factor. Only `totp` supported with this version but may change in\nfuture versions." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 200, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 413, + "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": 194, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 412, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 191, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 415, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Factor's status." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 203, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "verified" + }, + { + "type": "literal", + "value": "unverified" + } + ] + } + }, + { + "id": 417, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 206, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 416, + 414, + 413, + 412, + 415, + 417 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 189, + "character": 17 + } + ] + }, + { + "id": 610, + "name": "GenerateLinkOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 611, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 596, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 612, + "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": 598, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 611, + 612 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 590, + "character": 17 + } + ] + }, + { + "id": 769, + "name": "GoTrueAdminMFAApi", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "Contains the full multi-factor authentication administration API.", + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "children": [ + { + "id": 773, + "name": "deleteFactor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 774, + "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": 775, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 753, + "name": "AuthMFAAdminDeleteFactorParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 744, + "name": "AuthMFAAdminDeleteFactorResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 770, + "name": "listFactors", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 771, + "name": "listFactors", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Lists all factors associated to a user." + }, + "parameters": [ + { + "id": 772, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 766, + "name": "AuthMFAAdminListFactorsParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 757, + "name": "AuthMFAAdminListFactorsResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "kind": 2048, + "children": [ + 773, + 770 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 928, + "character": 17 + } + ] + }, + { + "id": 724, + "name": "GoTrueMFAApi", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "Contains the full multi-factor authentication API." + }, + "children": [ + { + "id": 728, + "name": "challenge", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 729, + "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": 730, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 648, + "name": "MFAChallengeParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 692, + "name": "AuthMFAChallengeResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 737, + "name": "challengeAndVerify", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 738, + "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": 739, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 651, + "name": "MFAChallengeAndVerifyParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 655, + "name": "AuthMFAVerifyResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 725, + "name": "enroll", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 726, + "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": 727, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 635, + "name": "MFAEnrollParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 668, + "name": "AuthMFAEnrollResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 742, + "name": "getAuthenticatorAssuranceLevel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 743, + "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": 713, + "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 740, + "name": "listFactors", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 741, + "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": 702, + "name": "AuthMFAListFactorsResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 734, + "name": "unenroll", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 735, + "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": 736, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 640, + "name": "MFAUnenrollParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 683, + "name": "AuthMFAUnenrollResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 731, + "name": "verify", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 732, + "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": 733, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 643, + "name": "MFAVerifyParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 655, + "name": "AuthMFAVerifyResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "kind": 2048, + "children": [ + 728, + 737, + 725, + 742, + 740, + 734, + 731 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 815, + "character": 17 + } + ] + }, + { + "id": 388, + "name": "Session", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 391, + "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": 134, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 394, + "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": 146, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 393, + "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": 142, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 390, + "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": 130, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 389, + "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": 125, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 392, + "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": 138, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "token_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 396, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 148, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 425, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 391, + 394, + 393, + 390, + 389, + 392, + 395, + 396 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 121, + "character": 17 + } + ] + }, + { + "id": 464, + "name": "Subscription", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 465, + "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": 329, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 466, + "name": "callback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 333, + "character": 2 + } + ], + "signatures": [ + { + "id": 467, + "name": "callback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "The function to call every time there is an event. eg: (eventName) => {}" + }, + "parameters": [ + { + "id": 468, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 327, + "name": "AuthChangeEvent" + } + }, + { + "id": 469, + "name": "session", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 388, + "name": "Session" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 470, + "name": "unsubscribe", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 337, + "character": 2 + } + ], + "signatures": [ + { + "id": 471, + "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": [ + 465 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 466, + 470 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 325, + "character": 17 + } + ] + }, + { + "id": 472, + "name": "UpdatableFactorAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 473, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 473 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 340, + "character": 17 + } + ] + }, + { + "id": 425, + "name": "User", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 436, + "name": "action_link", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 229, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 427, + "name": "app_metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 220, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 418, + "name": "UserAppMetadata" + } + }, + { + "id": 429, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 430, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 440, + "name": "confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 233, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 439, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 232, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 437, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 230, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 432, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 234, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 447, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 240, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 411, + "name": "Factor" + } + } + }, + { + "id": 426, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 239, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 400, + "name": "UserIdentity" + } + } + }, + { + "id": 435, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 228, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 236, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 433, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 434, + "name": "new_phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 227, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 438, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 231, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 442, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 235, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 431, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 224, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 444, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 237, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 445, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 238, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 428, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 221, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 422, + "name": "UserMetadata" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 436, + 427, + 429, + 430, + 440, + 439, + 437, + 432, + 441, + 447, + 426, + 446, + 435, + 443, + 433, + 434, + 438, + 442, + 431, + 444, + 445, + 428 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 218, + "character": 17 + } + ] + }, + { + "id": 418, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 419, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 419 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 209, + "character": 17 + } + ], + "indexSignature": { + "id": 420, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 421, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "id": 448, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 453, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 272, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 449, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 247, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 452, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 257, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 450, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 252, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 453, + 449, + 452, + 451, + 450 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 243, + "character": 17 + } + ] + }, + { + "id": 400, + "name": "UserIdentity", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 408, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 177, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 401, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 171, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 403, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 173, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 404, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 405, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 406, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 409, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 178, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 407, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 176, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 410, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 179, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 402, + "name": "user_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 172, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 408, + 401, + 403, + 409, + 407, + 410, + 402 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 170, + "character": 17 + } + ] + }, + { + "id": 422, + "name": "UserMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 214, + "character": 17 + } + ], + "indexSignature": { + "id": 423, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 424, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "id": 552, + "name": "VerifyEmailOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 553, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 500, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 556, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 505, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 557, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 559, + "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": 509, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 558, + "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": 507, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 559, + 558 + ] + } + ] + } + } + }, + { + "id": 554, + "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": 502, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 555, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 504, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 561, + "name": "EmailOtpType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 553, + 556, + 554, + 555 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 498, + "character": 17 + } + ] + }, + { + "id": 544, + "name": "VerifyMobileOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 548, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 486, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 549, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 551, + "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": 495, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 550, + "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": 488, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 551, + 550 + ] + } + ] + } + } + }, + { + "id": 545, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 481, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 546, + "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": 483, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 547, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 485, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 560, + "name": "MobileOtpType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 548, + 545, + 546, + 547 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 479, + "character": 17 + } + ] + }, + { + "id": 327, + "name": "AuthChangeEvent", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 26, + "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" + }, + { + "type": "reference", + "id": 326, + "name": "AuthChangeEventMFA" + } + ] + } + }, + { + "id": 326, + "name": "AuthChangeEventMFA", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 24, + "character": 12 + } + ], + "type": { + "type": "literal", + "value": "MFA_CHALLENGE_VERIFIED" + } + }, + { + "id": 522, + "name": "AuthFlowType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 447, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "implicit" + }, + { + "type": "literal", + "value": "pkce" + } + ] + } + }, + { + "id": 753, + "name": "AuthMFAAdminDeleteFactorParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 894, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 754, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 755, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the MFA factor to delete." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 896, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 756, + "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": 899, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 755, + 756 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 894, + "character": 45 + } + ] + } + } + }, + { + "id": 744, + "name": "AuthMFAAdminDeleteFactorResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 881, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 745, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 746, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 883, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 747, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 748, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully deleted." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 885, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 748 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 883, + "character": 12 + } + ] + } + } + }, + { + "id": 749, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 887, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 746, + 749 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 882, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 750, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 751, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 889, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 752, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 889, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 751, + 752 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 889, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 766, + "name": "AuthMFAAdminListFactorsParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 918, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 767, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 768, + "name": "userId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 920, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 768 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 918, + "character": 44 + } + ] + } + } + }, + { + "id": 757, + "name": "AuthMFAAdminListFactorsResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 905, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 758, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 759, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 760, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 761, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "All factors attached to the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 909, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 411, + "name": "Factor" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 761 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 12 + } + ] + } + } + }, + { + "id": 762, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 911, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 759, + 762 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 906, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 763, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 764, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 913, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 765, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 913, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 764, + 765 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 913, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 692, + "name": "AuthMFAChallengeResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 758, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 693, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 694, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 760, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 695, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 697, + "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": 765, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 696, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the newly created challenge." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 762, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 697, + 696 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 760, + "character": 12 + } + ] + } + } + }, + { + "id": 698, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 767, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 694, + 698 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 759, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 699, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 700, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 701, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 700, + 701 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 668, + "name": "AuthMFAEnrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 715, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 669, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 670, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 717, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 671, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 672, + "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": 719, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 674, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 725, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 675, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 676, + "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": 729, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 677, + "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": 734, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 678, + "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": 738, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 676, + 677, + 678 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 725, + "character": 14 + } + ] + } + } + }, + { + "id": 673, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor. Only `totp` supported for now." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 722, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 672, + 674, + 673 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 717, + "character": 12 + } + ] + } + } + }, + { + "id": 679, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 741, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 670, + 679 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 716, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 680, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 681, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 744, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 682, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 745, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 681, + 682 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 743, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 713, + "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 786, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 714, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 715, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 788, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 716, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 719, + "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": 805, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 397, + "name": "AMREntry" + } + } + }, + { + "id": 717, + "name": "currentLevel", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Current AAL level of the session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 790, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 712, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 718, + "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": 798, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 712, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 719, + 717, + 718 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 788, + "character": 12 + } + ] + } + } + }, + { + "id": 720, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 807, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 715, + 720 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 787, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 721, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 722, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 809, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 723, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 809, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 722, + 723 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 809, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 702, + "name": "AuthMFAListFactorsResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 771, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 703, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 704, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 773, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 705, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 706, + "name": "all", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "All available factors (verified and unverified)." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 775, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 411, + "name": "Factor" + } + } + }, + { + "id": 707, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only verified TOTP factors. (A subset of `all`.)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 778, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 411, + "name": "Factor" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 706, + 707 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 773, + "character": 12 + } + ] + } + } + }, + { + "id": 708, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 780, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 704, + 708 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 772, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 709, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 710, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 711, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 710, + 711 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 683, + "name": "AuthMFAUnenrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 748, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 684, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 685, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 750, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 686, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 687, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 752, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 687 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 750, + "character": 12 + } + ] + } + } + }, + { + "id": 688, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 754, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 685, + 688 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 749, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 689, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 690, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 756, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 691, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 756, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 690, + 691 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 756, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 655, + "name": "AuthMFAVerifyResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 690, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 656, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 657, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 692, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 658, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 659, + "name": "access_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "New access token (JWT) after successful verification." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 694, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 661, + "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": 700, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 662, + "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": 703, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 660, + "name": "token_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of token, typically `Bearer`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 697, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Updated user profile." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 706, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 425, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 659, + 661, + 662, + 660, + 663 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 692, + "character": 12 + } + ] + } + } + }, + { + "id": 664, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 708, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 657, + 664 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 691, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 665, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 666, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 711, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 667, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 712, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 666, + 667 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 710, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 342, + "name": "AuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 343, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 344, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 58, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 345, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 347, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 60, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 346, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 59, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 425, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 347, + 346 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 58, + "character": 12 + } + ] + } + } + }, + { + "id": 348, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 344, + 348 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 57, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 349, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 350, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 65, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 351, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 353, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 352, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 353, + 352 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 65, + "character": 12 + } + ] + } + } + }, + { + "id": 354, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 350, + 354 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 64, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 712, + "name": "AuthenticatorAssuranceLevels", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 784, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "aal1" + }, + { + "type": "literal", + "value": "aal2" + } + ] + } + }, + { + "id": 780, + "name": "CallRefreshTokenResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 959, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 781, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 783, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 962, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 782, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 961, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 388, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 783, + 782 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 960, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 784, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 786, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 966, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + }, + { + "id": 785, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 965, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 786, + 785 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 964, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 561, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 514, + "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": 604, + "name": "GenerateEmailChangeLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 579, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 605, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 607, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 582, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 608, + "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": 586, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 609, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 587, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 610, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 606, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 580, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "email_change_current" + }, + { + "type": "literal", + "value": "email_change_new" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 607, + 608, + 609, + 606 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 579, + "character": 44 + } + ] + } + } + }, + { + "id": 594, + "name": "GenerateInviteOrMagiclinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 565, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 595, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 597, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 568, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 598, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 569, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 610, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 596, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 566, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 597, + 598, + 596 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 565, + "character": 46 + } + ] + } + } + }, + { + "id": 613, + "name": "GenerateLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 601, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 588, + "name": "GenerateSignupLinkParams" + }, + { + "type": "reference", + "id": 594, + "name": "GenerateInviteOrMagiclinkParams" + }, + { + "type": "reference", + "id": 599, + "name": "GenerateRecoveryLinkParams" + }, + { + "type": "reference", + "id": 604, + "name": "GenerateEmailChangeLinkParams" + } + ] + } + }, + { + "id": 627, + "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": 624, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 628, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 629, + "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": 629, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 630, + "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": 634, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 631, + "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": 638, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 632, + "name": "redirect_to", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The URL appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 640, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 633, + "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": 642, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 634, + "name": "GenerateLinkType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 629, + 630, + 631, + 632, + 633 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 624, + "character": 37 + } + ] + } + } + }, + { + "id": 614, + "name": "GenerateLinkResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 607, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 615, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 616, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 609, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 617, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 618, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 610, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 627, + "name": "GenerateLinkProperties" + } + }, + { + "id": 619, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 611, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 425, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 618, + 619 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 609, + "character": 12 + } + ] + } + } + }, + { + "id": 620, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 613, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 616, + 620 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 608, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 621, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 622, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 616, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 623, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 624, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 617, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 625, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 618, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 624, + 625 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 616, + "character": 12 + } + ] + } + } + }, + { + "id": 626, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 620, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 622, + 626 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 615, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 634, + "name": "GenerateLinkType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 645, + "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": 599, + "name": "GenerateRecoveryLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 572, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 600, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 602, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 575, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 603, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 576, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 610, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 601, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 573, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "recovery" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 602, + 603, + 601 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 572, + "character": 41 + } + ] + } + } + }, + { + "id": 588, + "name": "GenerateSignupLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 558, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 589, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 591, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 560, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 593, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 562, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 610, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 592, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 561, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 590, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 559, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "signup" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 591, + 593, + 592, + 590 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 558, + "character": 39 + } + ] + } + } + }, + { + "id": 328, + "name": "GoTrueClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 329, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 337, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 336, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 340, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 51, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "Fetch" + } + }, + { + "id": 341, + "name": "flowType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 53, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 522, + "name": "AuthFlowType" + } + }, + { + "id": 331, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 332, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 39, + "character": 12 + } + ], + "indexSignature": { + "id": 333, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 334, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 338, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 339, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 776, + "name": "SupportedStorage" + } + }, + { + "id": 335, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 330, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 337, + 336, + 340, + 341, + 331, + 338, + 339, + 335, + 330 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 34 + } + ] + } + } + }, + { + "id": 777, + "name": "InitializeResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 957, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 778, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 779, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 957, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 804, + "name": "AuthError" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 779 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 957, + "character": 31 + } + ] + } + } + }, + { + "id": 651, + "name": "MFAChallengeAndVerifyParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 683, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 652, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 654, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Verification code provided by the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 687, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 653, + "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": 685, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 654, + 653 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 683, + "character": 42 + } + ] + } + } + }, + { + "id": 648, + "name": "MFAChallengeParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 678, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 649, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 650, + "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": 680, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 650 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 678, + "character": 33 + } + ] + } + } + }, + { + "id": 635, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 653, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 636, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 637, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 655, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 639, + "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": 659, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 638, + "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": 657, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 637, + 639, + 638 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 653, + "character": 30 + } + ] + } + } + }, + { + "id": 640, + "name": "MFAUnenrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 662, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 641, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 642, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor being unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 664, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 642 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 662, + "character": 32 + } + ] + } + } + }, + { + "id": 643, + "name": "MFAVerifyParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 667, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 644, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 646, + "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": 672, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 647, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Verification code provided by the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 675, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 645, + "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": 669, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 646, + 647, + 645 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 667, + "character": 30 + } + ] + } + } + }, + { + "id": 560, + "name": "MobileOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 513, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "phone_change" + } + ] + } + }, + { + "id": 355, + "name": "OAuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "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/lib/types.ts", + "line": 74, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 358, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 359, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 325, + "name": "Provider" + } + }, + { + "id": 360, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 359, + 360 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 12 + } + ] + } + } + }, + { + "id": 361, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 357, + 361 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 362, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 363, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 81, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 364, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 365, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 82, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 325, + "name": "Provider" + } + }, + { + "id": 366, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 365, + 366 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 81, + "character": 12 + } + ] + } + } + }, + { + "id": 367, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 85, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 363, + 367 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 794, + "name": "PageParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 976, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 795, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 796, + "name": "page", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The page number" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 978, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 797, + "name": "perPage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Number of items returned per page" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 980, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 796, + 797 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 976, + "character": 25 + } + ] + } + } + }, + { + "id": 787, + "name": "Pagination", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 969, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 788, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 790, + "name": "lastPage", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 972, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 789, + "name": "nextPage", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 971, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 791, + "name": "total", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 973, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 790, + 789, + 791 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 969, + "character": 25 + } + ], + "indexSignature": { + "id": 792, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 793, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 325, + "name": "Provider", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 5, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "apple" + }, + { + "type": "literal", + "value": "azure" + }, + { + "type": "literal", + "value": "bitbucket" + }, + { + "type": "literal", + "value": "discord" + }, + { + "type": "literal", + "value": "facebook" + }, + { + "type": "literal", + "value": "github" + }, + { + "type": "literal", + "value": "gitlab" + }, + { + "type": "literal", + "value": "google" + }, + { + "type": "literal", + "value": "keycloak" + }, + { + "type": "literal", + "value": "linkedin" + }, + { + "type": "literal", + "value": "notion" + }, + { + "type": "literal", + "value": "slack" + }, + { + "type": "literal", + "value": "spotify" + }, + { + "type": "literal", + "value": "twitch" + }, + { + "type": "literal", + "value": "twitter" + }, + { + "type": "literal", + "value": "workos" + }, + { + "type": "literal", + "value": "zoom" + } + ] + } + }, + { + "id": 562, + "name": "ResendParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 516, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 563, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 565, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 519, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 566, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 567, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 568, + "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": 522, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 568 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 16 + } + ] + } + } + }, + { + "id": 564, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 518, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 561, + "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": [ + 565, + 566, + 564 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 517, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 569, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 572, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 573, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 574, + "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": 530, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 574 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 16 + } + ] + } + } + }, + { + "id": 571, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 527, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 570, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 526, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 560, + "name": "MobileOtpType" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "phone" + } + ] + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 572, + 571, + 570 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 525, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 368, + "name": "SSOResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 369, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 370, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 371, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 372, + "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": 98, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 372 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 12 + } + ] + } + } + }, + { + "id": 373, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 370, + 373 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 89, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 374, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 375, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 103, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 376, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 375, + 376 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 102, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 535, + "name": "SignInWithIdTokenCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 463, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 536, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 539, + "name": "nonce", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If the ID token contains a `nonce`, then the hash of this value is compared to the value in the ID token." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 471, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 540, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 472, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 541, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 542, + "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": 474, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 542 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 472, + "character": 12 + } + ] + } + } + }, + { + "id": 537, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only Apple and Google ID tokens are supported for use from within iOS or Android applications." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 467, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "google" + }, + { + "type": "literal", + "value": "apple" + } + ] + } + }, + { + "id": 538, + "name": "token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID token issued by Apple or Google." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 469, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 539, + 540, + 537, + 538 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 463, + "character": 43 + } + ] + } + } + }, + { + "id": 523, + "name": "SignInWithOAuthCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 524, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 526, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 451, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 527, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 530, + "name": "queryParams", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "An object of query params" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 457, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 531, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 457, + "character": 18 + } + ], + "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": 528, + "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": 453, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 529, + "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": 455, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "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": 459, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 530, + 528, + 529, + 534 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 451, + "character": 12 + } + ] + } + } + }, + { + "id": 525, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 450, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 325, + "name": "Provider" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 526, + 525 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 41 + } + ] + } + } + }, + { + "id": 491, + "name": "SignInWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 381, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 492, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 493, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 384, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 495, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 387, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 496, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 497, + "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": 389, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 497 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 387, + "character": 16 + } + ] + } + } + }, + { + "id": 494, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 386, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 493, + 495, + 494 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 382, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 498, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 501, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 397, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 502, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 504, + "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": 405, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 503, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 403, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 504, + 503 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 397, + "character": 16 + } + ] + } + } + }, + { + "id": 500, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 396, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 499, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 394, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 501, + 500, + 499 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 392, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 505, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 409, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 506, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 507, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 412, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 508, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 413, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 509, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 513, + "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": 425, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 512, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 423, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 510, + "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": 415, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 511, + "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": 417, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 513, + 512, + 510, + 511 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 413, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 507, + 508 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 410, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 514, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 516, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 431, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 517, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 520, + "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": 441, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 521, + "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": 443, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 519, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 439, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 518, + "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": 433, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 520, + 521, + 519, + 518 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 431, + "character": 16 + } + ] + } + } + }, + { + "id": 515, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 430, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 516, + 515 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 428, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 575, + "name": "SignInWithSSO", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 534, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 576, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 578, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 539, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 579, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 581, + "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": 543, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 580, + "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": 541, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 581, + 580 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 539, + "character": 16 + } + ] + } + } + }, + { + "id": 577, + "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": 537, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 578, + 577 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 535, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 582, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 583, + "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": 548, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 584, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 550, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 585, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 587, + "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": 554, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 586, + "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": 552, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 587, + 586 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 550, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 583, + 584 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 546, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 474, + "name": "SignUpWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 475, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 476, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 478, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 350, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 479, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 482, + "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": 360, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 481, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 358, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 480, + "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": 352, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 482, + 481, + 480 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 350, + "character": 16 + } + ] + } + } + }, + { + "id": 477, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 349, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 476, + 478, + 477 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 345, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 483, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 486, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 487, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 489, + "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": 376, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 490, + "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": 378, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 488, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 374, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 489, + 490, + 488 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 16 + } + ] + } + } + }, + { + "id": 485, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 367, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 484, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 365, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 486, + 485, + 484 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 363, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 776, + "name": "SupportedStorage", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 955, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Storage", + "package": "typescript", + "name": "Storage" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "getItem" + }, + { + "type": "literal", + "value": "setItem" + }, + { + "type": "literal", + "value": "removeItem" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + ], + "name": "PromisifyMethods" + } + }, + { + "id": 377, + "name": "UserResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 378, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 379, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 380, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 381, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 425, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 381 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 12 + } + ] + } + } + }, + { + "id": 382, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 379, + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 383, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 384, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 385, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 386, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 386 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 12 + } + ] + } + } + }, + { + "id": 387, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 384, + 387 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 543, + "name": "VerifyOtpParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 478, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 544, + "name": "VerifyMobileOtpParams" + }, + { + "type": "reference", + "id": 552, + "name": "VerifyEmailOtpParams" + } + ] + } + }, + { + "id": 801, + "name": "isAuthApiError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 34, + "character": 16 + } + ], + "signatures": [ + { + "id": 802, + "name": "isAuthApiError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 803, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 811, + "name": "AuthApiError" + } + } + } + ] + }, + { + "id": 798, + "name": "isAuthError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 12, + "character": 16 + } + ], + "signatures": [ + { + "id": 799, + "name": "isAuthError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 800, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [ + 811, + 804, + 872, + 859, + 897, + 922, + 847, + 824, + 832, + 1, + 77 + ] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [ + 397, + 454, + 411, + 610, + 769, + 724, + 388, + 464, + 472, + 425, + 418, + 448, + 400, + 422, + 552, + 544 + ] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [ + 327, + 326, + 522, + 753, + 744, + 766, + 757, + 692, + 668, + 713, + 702, + 683, + 655, + 342, + 712, + 780, + 561, + 604, + 594, + 613, + 627, + 614, + 634, + 599, + 588, + 328, + 777, + 651, + 648, + 635, + 640, + 643, + 560, + 355, + 794, + 787, + 325, + 562, + 368, + 535, + 523, + 491, + 505, + 575, + 474, + 776, + 377, + 543 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [ + 801, + 798 + ] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json index 824d55e949a..0c0f1e68836 100644 --- a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 791, + "id": 811, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 792, + "id": 812, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -28,14 +28,14 @@ ], "signatures": [ { - "id": 793, + "id": 813, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 794, + "id": 814, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +46,7 @@ } }, { - "id": 795, + "id": 815, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -59,24 +59,24 @@ ], "type": { "type": "reference", - "id": 791, + "id": 811, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 786, + "id": 806, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 785, + "id": 805, "name": "AuthError.constructor" } }, { - "id": 796, + "id": 816, "name": "status", "kind": 1024, "kindString": "Property", @@ -94,12 +94,12 @@ }, "overwrites": { "type": "reference", - "id": 789, + "id": 809, "name": "AuthError.status" } }, { - "id": 797, + "id": 817, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -113,7 +113,7 @@ ], "signatures": [ { - "id": 798, + "id": 818, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -121,14 +121,14 @@ "type": { "type": "reflection", "declaration": { - "id": 799, + "id": 819, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 801, + "id": 821, "name": "message", "kind": 1024, "kindString": "Property", @@ -147,7 +147,7 @@ "defaultValue": "..." }, { - "id": 800, + "id": 820, "name": "name", "kind": 1024, "kindString": "Property", @@ -166,7 +166,7 @@ "defaultValue": "..." }, { - "id": 802, + "id": 822, "name": "status", "kind": 1024, "kindString": "Property", @@ -189,7 +189,11 @@ { "title": "Properties", "kind": 1024, - "children": [801, 800, 802] + "children": [ + 821, + 820, + 822 + ] } ] } @@ -202,17 +206,23 @@ { "title": "Constructors", "kind": 512, - "children": [792] + "children": [ + 812 + ] }, { "title": "Properties", "kind": 1024, - "children": [796] + "children": [ + 816 + ] }, { "title": "Methods", "kind": 2048, - "children": [797] + "children": [ + 817 + ] } ], "sources": [ @@ -225,20 +235,20 @@ "extendedTypes": [ { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] }, { - "id": 784, + "id": 804, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 785, + "id": 805, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -252,14 +262,14 @@ ], "signatures": [ { - "id": 786, + "id": 806, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 787, + "id": 807, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -270,7 +280,7 @@ } }, { - "id": 788, + "id": 808, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -285,7 +295,7 @@ ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" }, "overwrites": { @@ -300,7 +310,7 @@ } }, { - "id": 789, + "id": 809, "name": "status", "kind": 1024, "kindString": "Property", @@ -331,12 +341,16 @@ { "title": "Constructors", "kind": 512, - "children": [785] + "children": [ + 805 + ] }, { "title": "Properties", "kind": 1024, - "children": [789] + "children": [ + 809 + ] } ], "sources": [ @@ -357,30 +371,30 @@ "extendedBy": [ { "type": "reference", - "id": 791, + "id": 811, "name": "AuthApiError" }, { "type": "reference", - "id": 804, + "id": 824, "name": "AuthUnknownError" }, { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 852, + "id": 872, "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 853, + "id": 873, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -394,14 +408,14 @@ ], "signatures": [ { - "id": 854, + "id": 874, "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 855, + "id": 875, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -412,7 +426,7 @@ } }, { - "id": 856, + "id": 876, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -427,14 +441,14 @@ { "type": "reflection", "declaration": { - "id": 857, + "id": 877, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 859, + "id": 879, "name": "code", "kind": 1024, "kindString": "Property", @@ -452,7 +466,7 @@ } }, { - "id": 858, + "id": 878, "name": "error", "kind": 1024, "kindString": "Property", @@ -474,7 +488,10 @@ { "title": "Properties", "kind": 1024, - "children": [859, 858] + "children": [ + 879, + 878 + ] } ] } @@ -486,24 +503,24 @@ ], "type": { "type": "reference", - "id": 852, + "id": 872, "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 860, + "id": 880, "name": "details", "kind": 1024, "kindString": "Property", @@ -525,14 +542,14 @@ { "type": "reflection", "declaration": { - "id": 861, + "id": 881, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 863, + "id": 883, "name": "code", "kind": 1024, "kindString": "Property", @@ -550,7 +567,7 @@ } }, { - "id": 862, + "id": 882, "name": "error", "kind": 1024, "kindString": "Property", @@ -572,7 +589,10 @@ { "title": "Properties", "kind": 1024, - "children": [863, 862] + "children": [ + 883, + 882 + ] } ] } @@ -582,7 +602,7 @@ "defaultValue": "null" }, { - "id": 874, + "id": 894, "name": "name", "kind": 1024, "kindString": "Property", @@ -600,12 +620,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 875, + "id": 895, "name": "status", "kind": 1024, "kindString": "Property", @@ -623,12 +643,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 864, + "id": 884, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -642,7 +662,7 @@ ], "signatures": [ { - "id": 865, + "id": 885, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -650,14 +670,14 @@ "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 886, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 870, + "id": 890, "name": "details", "kind": 1024, "kindString": "Property", @@ -679,14 +699,14 @@ { "type": "reflection", "declaration": { - "id": 871, + "id": 891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 873, + "id": 893, "name": "code", "kind": 1024, "kindString": "Property", @@ -704,7 +724,7 @@ } }, { - "id": 872, + "id": 892, "name": "error", "kind": 1024, "kindString": "Property", @@ -726,7 +746,10 @@ { "title": "Properties", "kind": 1024, - "children": [873, 872] + "children": [ + 893, + 892 + ] } ] } @@ -736,7 +759,7 @@ "defaultValue": "..." }, { - "id": 868, + "id": 888, "name": "message", "kind": 1024, "kindString": "Property", @@ -755,7 +778,7 @@ "defaultValue": "..." }, { - "id": 867, + "id": 887, "name": "name", "kind": 1024, "kindString": "Property", @@ -774,7 +797,7 @@ "defaultValue": "..." }, { - "id": 869, + "id": 889, "name": "status", "kind": 1024, "kindString": "Property", @@ -797,21 +820,26 @@ { "title": "Properties", "kind": 1024, - "children": [870, 868, 867, 869] + "children": [ + 890, + 888, + 887, + 889 + ] } ] } }, "overwrites": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "overwrites": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -820,17 +848,25 @@ { "title": "Constructors", "kind": 512, - "children": [853] + "children": [ + 873 + ] }, { "title": "Properties", "kind": 1024, - "children": [860, 874, 875] + "children": [ + 880, + 894, + 895 + ] }, { "title": "Methods", "kind": 2048, - "children": [864] + "children": [ + 884 + ] } ], "sources": [ @@ -843,20 +879,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 839, + "id": 859, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 840, + "id": 860, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -870,14 +906,14 @@ ], "signatures": [ { - "id": 841, + "id": 861, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 842, + "id": 862, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -890,24 +926,24 @@ ], "type": { "type": "reference", - "id": 839, + "id": 859, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 843, + "id": 863, "name": "name", "kind": 1024, "kindString": "Property", @@ -925,12 +961,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 844, + "id": 864, "name": "status", "kind": 1024, "kindString": "Property", @@ -948,12 +984,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 845, + "id": 865, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -967,7 +1003,7 @@ ], "signatures": [ { - "id": 846, + "id": 866, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -975,14 +1011,14 @@ "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 867, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 869, "name": "message", "kind": 1024, "kindString": "Property", @@ -1001,7 +1037,7 @@ "defaultValue": "..." }, { - "id": 848, + "id": 868, "name": "name", "kind": 1024, "kindString": "Property", @@ -1020,7 +1056,7 @@ "defaultValue": "..." }, { - "id": 850, + "id": 870, "name": "status", "kind": 1024, "kindString": "Property", @@ -1043,21 +1079,25 @@ { "title": "Properties", "kind": 1024, - "children": [849, 848, 850] + "children": [ + 869, + 868, + 870 + ] } ] } }, "inheritedFrom": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -1066,17 +1106,24 @@ { "title": "Constructors", "kind": 512, - "children": [840] + "children": [ + 860 + ] }, { "title": "Properties", "kind": 1024, - "children": [843, 844] + "children": [ + 863, + 864 + ] }, { "title": "Methods", "kind": 2048, - "children": [845] + "children": [ + 865 + ] } ], "sources": [ @@ -1089,20 +1136,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 877, + "id": 897, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 878, + "id": 898, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1116,14 +1163,14 @@ ], "signatures": [ { - "id": 879, + "id": 899, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 880, + "id": 900, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1134,7 +1181,7 @@ } }, { - "id": 881, + "id": 901, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -1149,14 +1196,14 @@ { "type": "reflection", "declaration": { - "id": 882, + "id": 902, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 884, + "id": 904, "name": "code", "kind": 1024, "kindString": "Property", @@ -1174,7 +1221,7 @@ } }, { - "id": 883, + "id": 903, "name": "error", "kind": 1024, "kindString": "Property", @@ -1196,7 +1243,10 @@ { "title": "Properties", "kind": 1024, - "children": [884, 883] + "children": [ + 904, + 903 + ] } ] } @@ -1208,24 +1258,24 @@ ], "type": { "type": "reference", - "id": 877, + "id": 897, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 885, + "id": 905, "name": "details", "kind": 1024, "kindString": "Property", @@ -1247,14 +1297,14 @@ { "type": "reflection", "declaration": { - "id": 886, + "id": 906, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 888, + "id": 908, "name": "code", "kind": 1024, "kindString": "Property", @@ -1272,7 +1322,7 @@ } }, { - "id": 887, + "id": 907, "name": "error", "kind": 1024, "kindString": "Property", @@ -1294,7 +1344,10 @@ { "title": "Properties", "kind": 1024, - "children": [888, 887] + "children": [ + 908, + 907 + ] } ] } @@ -1304,7 +1357,7 @@ "defaultValue": "null" }, { - "id": 899, + "id": 919, "name": "name", "kind": 1024, "kindString": "Property", @@ -1322,12 +1375,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 900, + "id": 920, "name": "status", "kind": 1024, "kindString": "Property", @@ -1345,12 +1398,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 889, + "id": 909, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1364,7 +1417,7 @@ ], "signatures": [ { - "id": 890, + "id": 910, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1372,14 +1425,14 @@ "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 911, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 895, + "id": 915, "name": "details", "kind": 1024, "kindString": "Property", @@ -1401,14 +1454,14 @@ { "type": "reflection", "declaration": { - "id": 896, + "id": 916, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 898, + "id": 918, "name": "code", "kind": 1024, "kindString": "Property", @@ -1426,7 +1479,7 @@ } }, { - "id": 897, + "id": 917, "name": "error", "kind": 1024, "kindString": "Property", @@ -1448,7 +1501,10 @@ { "title": "Properties", "kind": 1024, - "children": [898, 897] + "children": [ + 918, + 917 + ] } ] } @@ -1458,7 +1514,7 @@ "defaultValue": "..." }, { - "id": 893, + "id": 913, "name": "message", "kind": 1024, "kindString": "Property", @@ -1477,7 +1533,7 @@ "defaultValue": "..." }, { - "id": 892, + "id": 912, "name": "name", "kind": 1024, "kindString": "Property", @@ -1496,7 +1552,7 @@ "defaultValue": "..." }, { - "id": 894, + "id": 914, "name": "status", "kind": 1024, "kindString": "Property", @@ -1519,21 +1575,26 @@ { "title": "Properties", "kind": 1024, - "children": [895, 893, 892, 894] + "children": [ + 915, + 913, + 912, + 914 + ] } ] } }, "overwrites": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "overwrites": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -1542,17 +1603,25 @@ { "title": "Constructors", "kind": 512, - "children": [878] + "children": [ + 898 + ] }, { "title": "Properties", "kind": 1024, - "children": [885, 899, 900] + "children": [ + 905, + 919, + 920 + ] }, { "title": "Methods", "kind": 2048, - "children": [889] + "children": [ + 909 + ] } ], "sources": [ @@ -1565,20 +1634,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 902, + "id": 922, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 903, + "id": 923, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1592,14 +1661,14 @@ ], "signatures": [ { - "id": 904, + "id": 924, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 905, + "id": 925, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1610,7 +1679,7 @@ } }, { - "id": 906, + "id": 926, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -1623,24 +1692,24 @@ ], "type": { "type": "reference", - "id": 902, + "id": 922, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 907, + "id": 927, "name": "name", "kind": 1024, "kindString": "Property", @@ -1658,12 +1727,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 908, + "id": 928, "name": "status", "kind": 1024, "kindString": "Property", @@ -1681,12 +1750,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 909, + "id": 929, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1700,7 +1769,7 @@ ], "signatures": [ { - "id": 910, + "id": 930, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1708,14 +1777,14 @@ "type": { "type": "reflection", "declaration": { - "id": 911, + "id": 931, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 933, "name": "message", "kind": 1024, "kindString": "Property", @@ -1734,7 +1803,7 @@ "defaultValue": "..." }, { - "id": 912, + "id": 932, "name": "name", "kind": 1024, "kindString": "Property", @@ -1753,7 +1822,7 @@ "defaultValue": "..." }, { - "id": 914, + "id": 934, "name": "status", "kind": 1024, "kindString": "Property", @@ -1776,21 +1845,25 @@ { "title": "Properties", "kind": 1024, - "children": [913, 912, 914] + "children": [ + 933, + 932, + 934 + ] } ] } }, "inheritedFrom": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -1799,17 +1872,24 @@ { "title": "Constructors", "kind": 512, - "children": [903] + "children": [ + 923 + ] }, { "title": "Properties", "kind": 1024, - "children": [907, 908] + "children": [ + 927, + 928 + ] }, { "title": "Methods", "kind": 2048, - "children": [909] + "children": [ + 929 + ] } ], "sources": [ @@ -1822,20 +1902,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 827, + "id": 847, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 828, + "id": 848, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1849,31 +1929,31 @@ ], "signatures": [ { - "id": 829, + "id": 849, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 827, + "id": 847, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 814, + "id": 834, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 813, + "id": 833, "name": "CustomAuthError.constructor" } }, { - "id": 830, + "id": 850, "name": "name", "kind": 1024, "kindString": "Property", @@ -1891,12 +1971,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 818, + "id": 838, "name": "CustomAuthError.name" } }, { - "id": 831, + "id": 851, "name": "status", "kind": 1024, "kindString": "Property", @@ -1914,12 +1994,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 819, + "id": 839, "name": "CustomAuthError.status" } }, { - "id": 832, + "id": 852, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1933,7 +2013,7 @@ ], "signatures": [ { - "id": 833, + "id": 853, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1941,14 +2021,14 @@ "type": { "type": "reflection", "declaration": { - "id": 834, + "id": 854, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 836, + "id": 856, "name": "message", "kind": 1024, "kindString": "Property", @@ -1967,7 +2047,7 @@ "defaultValue": "..." }, { - "id": 835, + "id": 855, "name": "name", "kind": 1024, "kindString": "Property", @@ -1986,7 +2066,7 @@ "defaultValue": "..." }, { - "id": 837, + "id": 857, "name": "status", "kind": 1024, "kindString": "Property", @@ -2009,21 +2089,25 @@ { "title": "Properties", "kind": 1024, - "children": [836, 835, 837] + "children": [ + 856, + 855, + 857 + ] } ] } }, "inheritedFrom": { "type": "reference", - "id": 821, + "id": 841, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 820, + "id": 840, "name": "CustomAuthError.toJSON" } } @@ -2032,17 +2116,24 @@ { "title": "Constructors", "kind": 512, - "children": [828] + "children": [ + 848 + ] }, { "title": "Properties", "kind": 1024, - "children": [830, 831] + "children": [ + 850, + 851 + ] }, { "title": "Methods", "kind": 2048, - "children": [832] + "children": [ + 852 + ] } ], "sources": [ @@ -2055,20 +2146,20 @@ "extendedTypes": [ { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" } ] }, { - "id": 804, + "id": 824, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 805, + "id": 825, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2082,14 +2173,14 @@ ], "signatures": [ { - "id": 806, + "id": 826, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 807, + "id": 827, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2100,7 +2191,7 @@ } }, { - "id": 808, + "id": 828, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2113,24 +2204,24 @@ ], "type": { "type": "reference", - "id": 804, + "id": 824, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 786, + "id": 806, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 785, + "id": 805, "name": "AuthError.constructor" } }, { - "id": 809, + "id": 829, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2148,7 +2239,7 @@ } }, { - "id": 810, + "id": 830, "name": "status", "kind": 1024, "kindString": "Property", @@ -2175,7 +2266,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 789, + "id": 809, "name": "AuthError.status" } } @@ -2184,12 +2275,17 @@ { "title": "Constructors", "kind": 512, - "children": [805] + "children": [ + 825 + ] }, { "title": "Properties", "kind": 1024, - "children": [809, 810] + "children": [ + 829, + 830 + ] } ], "sources": [ @@ -2202,20 +2298,20 @@ "extendedTypes": [ { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] }, { - "id": 812, + "id": 832, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 813, + "id": 833, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2229,14 +2325,14 @@ ], "signatures": [ { - "id": 814, + "id": 834, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 815, + "id": 835, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2247,7 +2343,7 @@ } }, { - "id": 816, + "id": 836, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -2258,7 +2354,7 @@ } }, { - "id": 817, + "id": 837, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2271,24 +2367,24 @@ ], "type": { "type": "reference", - "id": 812, + "id": 832, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 786, + "id": 806, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 785, + "id": 805, "name": "AuthError.constructor" } }, { - "id": 818, + "id": 838, "name": "name", "kind": 1024, "kindString": "Property", @@ -2310,7 +2406,7 @@ } }, { - "id": 819, + "id": 839, "name": "status", "kind": 1024, "kindString": "Property", @@ -2328,12 +2424,12 @@ }, "overwrites": { "type": "reference", - "id": 789, + "id": 809, "name": "AuthError.status" } }, { - "id": 820, + "id": 840, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -2347,7 +2443,7 @@ ], "signatures": [ { - "id": 821, + "id": 841, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -2355,14 +2451,14 @@ "type": { "type": "reflection", "declaration": { - "id": 822, + "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 824, + "id": 844, "name": "message", "kind": 1024, "kindString": "Property", @@ -2381,7 +2477,7 @@ "defaultValue": "..." }, { - "id": 823, + "id": 843, "name": "name", "kind": 1024, "kindString": "Property", @@ -2400,7 +2496,7 @@ "defaultValue": "..." }, { - "id": 825, + "id": 845, "name": "status", "kind": 1024, "kindString": "Property", @@ -2423,7 +2519,11 @@ { "title": "Properties", "kind": 1024, - "children": [824, 823, 825] + "children": [ + 844, + 843, + 845 + ] } ] } @@ -2436,17 +2536,24 @@ { "title": "Constructors", "kind": 512, - "children": [813] + "children": [ + 833 + ] }, { "title": "Properties", "kind": 1024, - "children": [818, 819] + "children": [ + 838, + 839 + ] }, { "title": "Methods", "kind": 2048, - "children": [820] + "children": [ + 840 + ] } ], "sources": [ @@ -2459,34 +2566,34 @@ "extendedTypes": [ { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 827, + "id": 847, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 839, + "id": 859, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 852, + "id": 872, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 877, + "id": 897, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 902, + "id": 922, "name": "AuthRetryableFetchError" } ] @@ -2696,7 +2803,11 @@ { "title": "Properties", "kind": 1024, - "children": [11, 7, 6] + "children": [ + 11, + 7, + 6 + ] } ] } @@ -2729,10 +2840,10 @@ ], "type": { "type": "reference", - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -2748,14 +2859,14 @@ }, "children": [ { - "id": 753, + "id": 773, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 754, + "id": 774, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -2775,17 +2886,17 @@ }, "parameters": [ { - "id": 755, + "id": 775, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -2801,21 +2912,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "id", "kind": 1024, "kindString": "Property", @@ -2826,7 +2937,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 870, + "line": 896, "character": 2 } ], @@ -2836,7 +2947,7 @@ } }, { - "id": 736, + "id": 756, "name": "userId", "kind": 1024, "kindString": "Property", @@ -2847,7 +2958,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 873, + "line": 899, "character": 2 } ], @@ -2861,13 +2972,16 @@ { "title": "Properties", "kind": 1024, - "children": [735, 736] + "children": [ + 755, + 756 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 45 } ] @@ -2882,7 +2996,7 @@ "typeArguments": [ { "type": "reference", - "id": 724, + "id": 744, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -2894,14 +3008,14 @@ ] }, { - "id": 750, + "id": 770, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 751, + "id": 771, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -2911,17 +3025,17 @@ }, "parameters": [ { - "id": 752, + "id": 772, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -2937,21 +3051,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 747, + "id": 767, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 768, "name": "userId", "kind": 1024, "kindString": "Property", @@ -2962,7 +3076,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 920, "character": 2 } ], @@ -2976,13 +3090,15 @@ { "title": "Properties", "kind": 1024, - "children": [748] + "children": [ + 768 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 44 } ] @@ -2997,7 +3113,7 @@ "typeArguments": [ { "type": "reference", - "id": 737, + "id": 757, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -3013,13 +3129,16 @@ { "title": "Methods", "kind": 2048, - "children": [753, 750] + "children": [ + 773, + 770 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 902, + "line": 928, "character": 17 } ] @@ -3035,7 +3154,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 146, + "line": 148, "character": 8 } ], @@ -3058,17 +3177,17 @@ "flags": {}, "type": { "type": "reference", - "id": 448, + "id": 454, "name": "AdminUserAttributes", "dereferenced": { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -3082,7 +3201,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -3092,7 +3211,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -3106,7 +3225,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -3116,7 +3235,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -3129,7 +3248,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -3143,7 +3262,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -3157,7 +3276,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -3167,7 +3286,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -3180,7 +3327,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -3194,7 +3341,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -3207,7 +3354,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -3221,7 +3368,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -3235,7 +3382,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -3245,7 +3392,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -3259,7 +3406,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -3273,13 +3420,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -3289,7 +3446,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -3311,7 +3468,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -3331,7 +3488,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 262, + "line": 264, "character": 8 } ], @@ -3381,7 +3538,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -3401,7 +3558,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 112, + "line": 114, "character": 8 } ], @@ -3424,10 +3581,10 @@ "flags": {}, "type": { "type": "reference", - "id": 593, + "id": 613, "name": "GenerateLinkParams", "dereferenced": { - "id": 593, + "id": 613, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -3435,7 +3592,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 601, "character": 12 } ], @@ -3443,7 +3600,7 @@ "type": "union", "types": [ { - "id": 568, + "id": 588, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -3451,21 +3608,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 589, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 571, + "id": 591, "name": "email", "kind": 1024, "kindString": "Property", @@ -3473,7 +3630,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 534, + "line": 560, "character": 2 } ], @@ -3483,7 +3640,7 @@ } }, { - "id": 573, + "id": 593, "name": "options", "kind": 1024, "kindString": "Property", @@ -3493,7 +3650,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 536, + "line": 562, "character": 2 } ], @@ -3502,7 +3659,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -3525,7 +3682,7 @@ } }, { - "id": 572, + "id": 592, "name": "password", "kind": 1024, "kindString": "Property", @@ -3533,7 +3690,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 535, + "line": 561, "character": 2 } ], @@ -3543,7 +3700,7 @@ } }, { - "id": 570, + "id": 590, "name": "type", "kind": 1024, "kindString": "Property", @@ -3551,7 +3708,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 533, + "line": 559, "character": 2 } ], @@ -3565,13 +3722,18 @@ { "title": "Properties", "kind": 1024, - "children": [571, 573, 572, 570] + "children": [ + 591, + 593, + 592, + 590 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 39 } ] @@ -3579,7 +3741,7 @@ } }, { - "id": 574, + "id": 594, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -3587,21 +3749,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 597, "name": "email", "kind": 1024, "kindString": "Property", @@ -3612,7 +3774,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 542, + "line": 568, "character": 2 } ], @@ -3622,7 +3784,7 @@ } }, { - "id": 578, + "id": 598, "name": "options", "kind": 1024, "kindString": "Property", @@ -3632,7 +3794,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 543, + "line": 569, "character": 2 } ], @@ -3641,7 +3803,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -3664,7 +3826,7 @@ } }, { - "id": 576, + "id": 596, "name": "type", "kind": 1024, "kindString": "Property", @@ -3672,7 +3834,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 540, + "line": 566, "character": 2 } ], @@ -3695,13 +3857,17 @@ { "title": "Properties", "kind": 1024, - "children": [577, 578, 576] + "children": [ + 597, + 598, + 596 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 46 } ] @@ -3709,7 +3875,7 @@ } }, { - "id": 579, + "id": 599, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -3717,21 +3883,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 602, "name": "email", "kind": 1024, "kindString": "Property", @@ -3742,7 +3908,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 575, "character": 2 } ], @@ -3752,7 +3918,7 @@ } }, { - "id": 583, + "id": 603, "name": "options", "kind": 1024, "kindString": "Property", @@ -3762,7 +3928,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 550, + "line": 576, "character": 2 } ], @@ -3771,7 +3937,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -3785,7 +3951,7 @@ } }, { - "id": 581, + "id": 601, "name": "type", "kind": 1024, "kindString": "Property", @@ -3793,7 +3959,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 547, + "line": 573, "character": 2 } ], @@ -3807,13 +3973,17 @@ { "title": "Properties", "kind": 1024, - "children": [582, 583, 581] + "children": [ + 602, + 603, + 601 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 41 } ] @@ -3821,7 +3991,7 @@ } }, { - "id": 584, + "id": 604, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -3829,21 +3999,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 607, "name": "email", "kind": 1024, "kindString": "Property", @@ -3854,7 +4024,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 556, + "line": 582, "character": 2 } ], @@ -3864,7 +4034,7 @@ } }, { - "id": 588, + "id": 608, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -3875,7 +4045,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 560, + "line": 586, "character": 2 } ], @@ -3885,7 +4055,7 @@ } }, { - "id": 589, + "id": 609, "name": "options", "kind": 1024, "kindString": "Property", @@ -3895,7 +4065,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 587, "character": 2 } ], @@ -3904,7 +4074,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -3918,7 +4088,7 @@ } }, { - "id": 586, + "id": 606, "name": "type", "kind": 1024, "kindString": "Property", @@ -3926,7 +4096,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 554, + "line": 580, "character": 2 } ], @@ -3949,13 +4119,18 @@ { "title": "Properties", "kind": 1024, - "children": [587, 588, 589, 586] + "children": [ + 607, + 608, + 609, + 606 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 44 } ] @@ -3973,7 +4148,7 @@ "typeArguments": [ { "type": "reference", - "id": 594, + "id": 614, "name": "GenerateLinkResponse" } ], @@ -3993,7 +4168,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 215, + "line": 217, "character": 8 } ], @@ -4028,7 +4203,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -4048,7 +4223,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 82, + "line": 81, "character": 8 } ], @@ -4083,6 +4258,9 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Additional options to be included when inviting.\n" + }, "type": { "type": "reflection", "declaration": { @@ -4093,7 +4271,7 @@ "flags": {}, "children": [ { - "id": 39, + "id": 38, "name": "data", "kind": 1024, "kindString": "Property", @@ -4101,12 +4279,12 @@ "isOptional": true }, "comment": { - "shortText": "Optional user metadata\n" + "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": 86, + "line": 85, "character": 6 } ], @@ -4116,7 +4294,7 @@ } }, { - "id": 38, + "id": 39, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -4124,12 +4302,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." + "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": 85, + "line": 88, "character": 6 } ], @@ -4143,7 +4321,10 @@ { "title": "Properties", "kind": 1024, - "children": [39, 38] + "children": [ + 38, + 39 + ] } ] } @@ -4156,7 +4337,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -4176,7 +4357,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 168, + "line": 170, "character": 8 } ], @@ -4205,10 +4386,10 @@ }, "type": { "type": "reference", - "id": 774, + "id": 794, "name": "PageParams", "dereferenced": { - "id": 774, + "id": 794, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -4216,21 +4397,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 775, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 796, "name": "page", "kind": 1024, "kindString": "Property", @@ -4243,7 +4424,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 952, + "line": 978, "character": 2 } ], @@ -4253,7 +4434,7 @@ } }, { - "id": 777, + "id": 797, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -4266,7 +4447,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 954, + "line": 980, "character": 2 } ], @@ -4280,13 +4461,16 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777] + "children": [ + 796, + 797 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 25 } ] @@ -4320,7 +4504,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 8 } ], @@ -4345,7 +4529,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 31 } ], @@ -4363,7 +4547,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 16 } ], @@ -4371,7 +4555,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 420, + "id": 425, "name": "User" } } @@ -4381,14 +4565,17 @@ { "title": "Properties", "kind": 1024, - "children": [53, 52] + "children": [ + 53, + 52 + ] } ] } }, { "type": "reference", - "id": 767, + "id": 787, "name": "Pagination" } ] @@ -4403,7 +4590,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 59 } ], @@ -4417,7 +4604,10 @@ { "title": "Properties", "kind": 1024, - "children": [50, 54] + "children": [ + 50, + 54 + ] } ] } @@ -4440,7 +4630,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 8 } ], @@ -4462,7 +4652,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 16 } ], @@ -4475,7 +4665,9 @@ { "title": "Properties", "kind": 1024, - "children": [58] + "children": [ + 58 + ] } ] } @@ -4490,13 +4682,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 29 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -4505,7 +4697,10 @@ { "title": "Properties", "kind": 1024, - "children": [56, 59] + "children": [ + 56, + 59 + ] } ] } @@ -4611,7 +4806,7 @@ }, { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] @@ -4622,7 +4817,10 @@ { "title": "Properties", "kind": 1024, - "children": [31, 32] + "children": [ + 31, + 32 + ] } ] } @@ -4644,7 +4842,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 237, + "line": 239, "character": 8 } ], @@ -4681,17 +4879,17 @@ }, "type": { "type": "reference", - "id": 448, + "id": 454, "name": "AdminUserAttributes", "dereferenced": { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -4705,7 +4903,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -4715,7 +4913,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -4729,7 +4927,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -4739,7 +4937,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -4752,7 +4950,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -4766,7 +4964,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -4780,7 +4978,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -4790,7 +4988,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -4803,7 +5029,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -4817,7 +5043,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -4830,7 +5056,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -4844,7 +5070,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -4858,7 +5084,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -4868,7 +5094,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -4882,7 +5108,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -4896,13 +5122,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -4912,7 +5148,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -4934,7 +5170,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -4950,17 +5186,30 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [ + 2 + ] }, { "title": "Properties", "kind": 1024, - "children": [16] + "children": [ + 16 + ] }, { "title": "Methods", "kind": 2048, - "children": [43, 67, 40, 60, 33, 46, 27, 63] + "children": [ + 43, + 67, + 40, + 60, + 33, + 46, + 27, + 63 + ] } ], "sources": [ @@ -4987,7 +5236,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 144, + "line": 145, "character": 2 } ], @@ -5010,10 +5259,10 @@ "flags": {}, "type": { "type": "reference", - "id": 323, + "id": 328, "name": "GoTrueClientOptions", "dereferenced": { - "id": 323, + "id": 328, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -5021,21 +5270,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 35, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 332, + "id": 337, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -5045,7 +5294,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 44, + "line": 45, "character": 2 } ], @@ -5055,7 +5304,7 @@ } }, { - "id": 331, + "id": 336, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -5065,7 +5314,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 42, + "line": 43, "character": 2 } ], @@ -5075,7 +5324,7 @@ } }, { - "id": 335, + "id": 340, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -5085,7 +5334,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 50, + "line": 51, "character": 2 } ], @@ -5095,7 +5344,7 @@ } }, { - "id": 336, + "id": 341, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -5105,16 +5354,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 52, + "line": 53, "character": 2 } ], "type": { "type": "reference", - "id": 515, + "id": 522, "name": "AuthFlowType", "dereferenced": { - "id": 515, + "id": 522, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -5122,7 +5371,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 439, + "line": 447, "character": 12 } ], @@ -5143,7 +5392,7 @@ } }, { - "id": 326, + "id": 331, "name": "headers", "kind": 1024, "kindString": "Property", @@ -5153,14 +5402,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 327, + "id": 332, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5168,19 +5417,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 12 } ], "indexSignature": { - "id": 328, + "id": 333, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 329, + "id": 334, "name": "key", "kind": 32768, "flags": {}, @@ -5199,7 +5448,7 @@ } }, { - "id": 333, + "id": 338, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -5209,7 +5458,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 47, "character": 2 } ], @@ -5219,7 +5468,7 @@ } }, { - "id": 334, + "id": 339, "name": "storage", "kind": 1024, "kindString": "Property", @@ -5229,16 +5478,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 49, "character": 2 } ], "type": { "type": "reference", - "id": 756, + "id": 776, "name": "SupportedStorage", "dereferenced": { - "id": 756, + "id": 776, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -5246,7 +5495,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 929, + "line": 955, "character": 12 } ], @@ -5291,7 +5540,7 @@ } }, { - "id": 330, + "id": 335, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -5301,7 +5550,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 40, + "line": 41, "character": 2 } ], @@ -5311,7 +5560,7 @@ } }, { - "id": 325, + "id": 330, "name": "url", "kind": 1024, "kindString": "Property", @@ -5321,7 +5570,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 36, + "line": 37, "character": 2 } ], @@ -5335,13 +5584,23 @@ { "title": "Properties", "kind": 1024, - "children": [332, 331, 335, 336, 326, 333, 334, 330, 325] + "children": [ + 337, + 336, + 340, + 341, + 331, + 338, + 339, + 335, + 330 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 35, "character": 34 } ] @@ -5371,7 +5630,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 97, + "line": 98, "character": 2 } ], @@ -5584,7 +5843,11 @@ { "title": "Properties", "kind": 1024, - "children": [11, 7, 6] + "children": [ + 11, + 7, + 6 + ] } ] } @@ -5617,10 +5880,10 @@ ], "type": { "type": "reference", - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -5636,14 +5899,14 @@ }, "children": [ { - "id": 753, + "id": 773, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 754, + "id": 774, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -5663,17 +5926,17 @@ }, "parameters": [ { - "id": 755, + "id": 775, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -5689,21 +5952,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "id", "kind": 1024, "kindString": "Property", @@ -5714,7 +5977,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 870, + "line": 896, "character": 2 } ], @@ -5724,7 +5987,7 @@ } }, { - "id": 736, + "id": 756, "name": "userId", "kind": 1024, "kindString": "Property", @@ -5735,7 +5998,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 873, + "line": 899, "character": 2 } ], @@ -5749,13 +6012,16 @@ { "title": "Properties", "kind": 1024, - "children": [735, 736] + "children": [ + 755, + 756 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 45 } ] @@ -5770,7 +6036,7 @@ "typeArguments": [ { "type": "reference", - "id": 724, + "id": 744, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -5782,14 +6048,14 @@ ] }, { - "id": 750, + "id": 770, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 751, + "id": 771, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -5799,17 +6065,17 @@ }, "parameters": [ { - "id": 752, + "id": 772, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -5825,21 +6091,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 747, + "id": 767, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 768, "name": "userId", "kind": 1024, "kindString": "Property", @@ -5850,7 +6116,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 920, "character": 2 } ], @@ -5864,13 +6130,15 @@ { "title": "Properties", "kind": 1024, - "children": [748] + "children": [ + 768 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 44 } ] @@ -5885,7 +6153,7 @@ "typeArguments": [ { "type": "reference", - "id": 737, + "id": 757, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -5901,13 +6169,16 @@ { "title": "Methods", "kind": 2048, - "children": [753, 750] + "children": [ + 773, + 770 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 902, + "line": 928, "character": 17 } ] @@ -5923,7 +6194,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 146, + "line": 148, "character": 8 } ], @@ -5946,17 +6217,17 @@ "flags": {}, "type": { "type": "reference", - "id": 448, + "id": 454, "name": "AdminUserAttributes", "dereferenced": { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -5970,7 +6241,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -5980,7 +6251,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -5994,7 +6265,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -6004,7 +6275,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -6017,7 +6288,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -6031,7 +6302,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -6045,7 +6316,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -6055,7 +6326,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -6068,7 +6367,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -6082,7 +6381,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -6095,7 +6394,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -6109,7 +6408,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -6123,7 +6422,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -6133,7 +6432,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -6147,7 +6446,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -6161,13 +6460,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -6177,7 +6486,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -6199,7 +6508,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -6219,7 +6528,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 262, + "line": 264, "character": 8 } ], @@ -6269,7 +6578,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -6289,7 +6598,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 112, + "line": 114, "character": 8 } ], @@ -6312,10 +6621,10 @@ "flags": {}, "type": { "type": "reference", - "id": 593, + "id": 613, "name": "GenerateLinkParams", "dereferenced": { - "id": 593, + "id": 613, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -6323,7 +6632,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 601, "character": 12 } ], @@ -6331,7 +6640,7 @@ "type": "union", "types": [ { - "id": 568, + "id": 588, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -6339,21 +6648,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 589, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 571, + "id": 591, "name": "email", "kind": 1024, "kindString": "Property", @@ -6361,7 +6670,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 534, + "line": 560, "character": 2 } ], @@ -6371,7 +6680,7 @@ } }, { - "id": 573, + "id": 593, "name": "options", "kind": 1024, "kindString": "Property", @@ -6381,7 +6690,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 536, + "line": 562, "character": 2 } ], @@ -6390,7 +6699,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -6413,7 +6722,7 @@ } }, { - "id": 572, + "id": 592, "name": "password", "kind": 1024, "kindString": "Property", @@ -6421,7 +6730,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 535, + "line": 561, "character": 2 } ], @@ -6431,7 +6740,7 @@ } }, { - "id": 570, + "id": 590, "name": "type", "kind": 1024, "kindString": "Property", @@ -6439,7 +6748,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 533, + "line": 559, "character": 2 } ], @@ -6453,13 +6762,18 @@ { "title": "Properties", "kind": 1024, - "children": [571, 573, 572, 570] + "children": [ + 591, + 593, + 592, + 590 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 39 } ] @@ -6467,7 +6781,7 @@ } }, { - "id": 574, + "id": 594, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -6475,21 +6789,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 597, "name": "email", "kind": 1024, "kindString": "Property", @@ -6500,7 +6814,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 542, + "line": 568, "character": 2 } ], @@ -6510,7 +6824,7 @@ } }, { - "id": 578, + "id": 598, "name": "options", "kind": 1024, "kindString": "Property", @@ -6520,7 +6834,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 543, + "line": 569, "character": 2 } ], @@ -6529,7 +6843,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -6552,7 +6866,7 @@ } }, { - "id": 576, + "id": 596, "name": "type", "kind": 1024, "kindString": "Property", @@ -6560,7 +6874,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 540, + "line": 566, "character": 2 } ], @@ -6583,13 +6897,17 @@ { "title": "Properties", "kind": 1024, - "children": [577, 578, 576] + "children": [ + 597, + 598, + 596 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 46 } ] @@ -6597,7 +6915,7 @@ } }, { - "id": 579, + "id": 599, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -6605,21 +6923,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 602, "name": "email", "kind": 1024, "kindString": "Property", @@ -6630,7 +6948,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 575, "character": 2 } ], @@ -6640,7 +6958,7 @@ } }, { - "id": 583, + "id": 603, "name": "options", "kind": 1024, "kindString": "Property", @@ -6650,7 +6968,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 550, + "line": 576, "character": 2 } ], @@ -6659,7 +6977,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -6673,7 +6991,7 @@ } }, { - "id": 581, + "id": 601, "name": "type", "kind": 1024, "kindString": "Property", @@ -6681,7 +6999,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 547, + "line": 573, "character": 2 } ], @@ -6695,13 +7013,17 @@ { "title": "Properties", "kind": 1024, - "children": [582, 583, 581] + "children": [ + 602, + 603, + 601 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 41 } ] @@ -6709,7 +7031,7 @@ } }, { - "id": 584, + "id": 604, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -6717,21 +7039,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 607, "name": "email", "kind": 1024, "kindString": "Property", @@ -6742,7 +7064,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 556, + "line": 582, "character": 2 } ], @@ -6752,7 +7074,7 @@ } }, { - "id": 588, + "id": 608, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -6763,7 +7085,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 560, + "line": 586, "character": 2 } ], @@ -6773,7 +7095,7 @@ } }, { - "id": 589, + "id": 609, "name": "options", "kind": 1024, "kindString": "Property", @@ -6783,7 +7105,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 587, "character": 2 } ], @@ -6792,7 +7114,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -6806,7 +7128,7 @@ } }, { - "id": 586, + "id": 606, "name": "type", "kind": 1024, "kindString": "Property", @@ -6814,7 +7136,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 554, + "line": 580, "character": 2 } ], @@ -6837,13 +7159,18 @@ { "title": "Properties", "kind": 1024, - "children": [587, 588, 589, 586] + "children": [ + 607, + 608, + 609, + 606 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 44 } ] @@ -6861,7 +7188,7 @@ "typeArguments": [ { "type": "reference", - "id": 594, + "id": 614, "name": "GenerateLinkResponse" } ], @@ -6881,7 +7208,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 215, + "line": 217, "character": 8 } ], @@ -6916,7 +7243,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -6936,7 +7263,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 82, + "line": 81, "character": 8 } ], @@ -6971,6 +7298,9 @@ "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Additional options to be included when inviting.\n" + }, "type": { "type": "reflection", "declaration": { @@ -6981,7 +7311,7 @@ "flags": {}, "children": [ { - "id": 39, + "id": 38, "name": "data", "kind": 1024, "kindString": "Property", @@ -6989,12 +7319,12 @@ "isOptional": true }, "comment": { - "shortText": "Optional user metadata\n" + "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": 86, + "line": 85, "character": 6 } ], @@ -7004,7 +7334,7 @@ } }, { - "id": 38, + "id": 39, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -7012,12 +7342,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." + "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": 85, + "line": 88, "character": 6 } ], @@ -7031,7 +7361,10 @@ { "title": "Properties", "kind": 1024, - "children": [39, 38] + "children": [ + 38, + 39 + ] } ] } @@ -7044,7 +7377,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -7064,7 +7397,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 168, + "line": 170, "character": 8 } ], @@ -7093,10 +7426,10 @@ }, "type": { "type": "reference", - "id": 774, + "id": 794, "name": "PageParams", "dereferenced": { - "id": 774, + "id": 794, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -7104,21 +7437,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 775, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 796, "name": "page", "kind": 1024, "kindString": "Property", @@ -7131,7 +7464,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 952, + "line": 978, "character": 2 } ], @@ -7141,7 +7474,7 @@ } }, { - "id": 777, + "id": 797, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -7154,7 +7487,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 954, + "line": 980, "character": 2 } ], @@ -7168,13 +7501,16 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777] + "children": [ + 796, + 797 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 25 } ] @@ -7208,7 +7544,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 8 } ], @@ -7233,7 +7569,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 31 } ], @@ -7251,7 +7587,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 16 } ], @@ -7259,7 +7595,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 420, + "id": 425, "name": "User" } } @@ -7269,14 +7605,17 @@ { "title": "Properties", "kind": 1024, - "children": [53, 52] + "children": [ + 53, + 52 + ] } ] } }, { "type": "reference", - "id": 767, + "id": 787, "name": "Pagination" } ] @@ -7291,7 +7630,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 171, + "line": 173, "character": 59 } ], @@ -7305,7 +7644,10 @@ { "title": "Properties", "kind": 1024, - "children": [50, 54] + "children": [ + 50, + 54 + ] } ] } @@ -7328,7 +7670,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 8 } ], @@ -7350,7 +7692,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 16 } ], @@ -7363,7 +7705,9 @@ { "title": "Properties", "kind": 1024, - "children": [58] + "children": [ + 58 + ] } ] } @@ -7378,13 +7722,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 172, + "line": 174, "character": 29 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -7393,7 +7737,10 @@ { "title": "Properties", "kind": 1024, - "children": [56, 59] + "children": [ + 56, + 59 + ] } ] } @@ -7499,7 +7846,7 @@ }, { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] @@ -7510,7 +7857,10 @@ { "title": "Properties", "kind": 1024, - "children": [31, 32] + "children": [ + 31, + 32 + ] } ] } @@ -7532,7 +7882,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 237, + "line": 239, "character": 8 } ], @@ -7569,17 +7919,17 @@ }, "type": { "type": "reference", - "id": 448, + "id": 454, "name": "AdminUserAttributes", "dereferenced": { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -7593,7 +7943,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -7603,7 +7953,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -7617,7 +7967,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -7627,7 +7977,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -7640,7 +7990,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -7654,7 +8004,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -7668,7 +8018,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -7678,7 +8028,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -7691,7 +8069,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -7705,7 +8083,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -7718,7 +8096,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -7732,7 +8110,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -7746,7 +8124,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -7756,7 +8134,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -7770,7 +8148,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -7784,13 +8162,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -7800,7 +8188,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -7822,7 +8210,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -7838,17 +8226,30 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [ + 2 + ] }, { "title": "Properties", "kind": 1024, - "children": [16] + "children": [ + 16 + ] }, { "title": "Methods", "kind": 2048, - "children": [43, 67, 40, 60, 33, 46, 27, 63] + "children": [ + 43, + 67, + 40, + 60, + 33, + 46, + 27, + 63 + ] } ], "sources": [ @@ -7873,16 +8274,16 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 101, + "line": 102, "character": 2 } ], "type": { "type": "reference", - "id": 704, + "id": 724, "name": "GoTrueMFAApi", "dereferenced": { - "id": 704, + "id": 724, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -7892,14 +8293,14 @@ }, "children": [ { - "id": 708, + "id": 728, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 709, + "id": 729, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -7909,17 +8310,17 @@ }, "parameters": [ { - "id": 710, + "id": 730, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 628, + "id": 648, "name": "MFAChallengeParams", "dereferenced": { - "id": 628, + "id": 648, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -7927,21 +8328,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 630, + "id": 650, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -7952,7 +8353,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 680, "character": 2 } ], @@ -7966,13 +8367,15 @@ { "title": "Properties", "kind": 1024, - "children": [630] + "children": [ + 650 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 33 } ] @@ -7987,7 +8390,7 @@ "typeArguments": [ { "type": "reference", - "id": 672, + "id": 692, "name": "AuthMFAChallengeResponse" } ], @@ -7999,14 +8402,14 @@ ] }, { - "id": 717, + "id": 737, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 718, + "id": 738, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -8016,17 +8419,17 @@ }, "parameters": [ { - "id": 719, + "id": 739, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -8034,21 +8437,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 634, + "id": 654, "name": "code", "kind": 1024, "kindString": "Property", @@ -8059,7 +8462,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 661, + "line": 687, "character": 2 } ], @@ -8069,7 +8472,7 @@ } }, { - "id": 633, + "id": 653, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -8080,7 +8483,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 685, "character": 2 } ], @@ -8094,13 +8497,16 @@ { "title": "Properties", "kind": 1024, - "children": [634, 633] + "children": [ + 654, + 653 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 42 } ] @@ -8115,7 +8521,7 @@ "typeArguments": [ { "type": "reference", - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse" } ], @@ -8127,14 +8533,14 @@ ] }, { - "id": 705, + "id": 725, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 706, + "id": 726, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -8145,17 +8551,17 @@ }, "parameters": [ { - "id": 707, + "id": 727, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 635, "name": "MFAEnrollParams", "dereferenced": { - "id": 615, + "id": 635, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -8163,21 +8569,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 636, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 637, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -8188,7 +8594,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 629, + "line": 655, "character": 2 } ], @@ -8198,7 +8604,7 @@ } }, { - "id": 619, + "id": 639, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -8211,7 +8617,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 633, + "line": 659, "character": 2 } ], @@ -8221,7 +8627,7 @@ } }, { - "id": 618, + "id": 638, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -8234,7 +8640,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 631, + "line": 657, "character": 2 } ], @@ -8248,13 +8654,17 @@ { "title": "Properties", "kind": 1024, - "children": [617, 619, 618] + "children": [ + 637, + 639, + 638 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 30 } ] @@ -8269,7 +8679,7 @@ "typeArguments": [ { "type": "reference", - "id": 648, + "id": 668, "name": "AuthMFAEnrollResponse" } ], @@ -8281,14 +8691,14 @@ ] }, { - "id": 722, + "id": 742, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 723, + "id": 743, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -8302,7 +8712,7 @@ "typeArguments": [ { "type": "reference", - "id": 693, + "id": 713, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -8314,14 +8724,14 @@ ] }, { - "id": 720, + "id": 740, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 721, + "id": 741, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -8348,7 +8758,7 @@ "typeArguments": [ { "type": "reference", - "id": 682, + "id": 702, "name": "AuthMFAListFactorsResponse" } ], @@ -8360,14 +8770,14 @@ ] }, { - "id": 714, + "id": 734, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 715, + "id": 735, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -8377,17 +8787,17 @@ }, "parameters": [ { - "id": 716, + "id": 736, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "dereferenced": { - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -8395,21 +8805,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 621, + "id": 641, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 642, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -8420,7 +8830,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 638, + "line": 664, "character": 2 } ], @@ -8434,13 +8844,15 @@ { "title": "Properties", "kind": 1024, - "children": [622] + "children": [ + 642 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 32 } ] @@ -8455,7 +8867,7 @@ "typeArguments": [ { "type": "reference", - "id": 663, + "id": 683, "name": "AuthMFAUnenrollResponse" } ], @@ -8467,14 +8879,14 @@ ] }, { - "id": 711, + "id": 731, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 712, + "id": 732, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -8484,17 +8896,17 @@ }, "parameters": [ { - "id": 713, + "id": 733, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 623, + "id": 643, "name": "MFAVerifyParams", "dereferenced": { - "id": 623, + "id": 643, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -8502,21 +8914,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 644, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 646, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -8527,7 +8939,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 672, "character": 2 } ], @@ -8537,7 +8949,7 @@ } }, { - "id": 627, + "id": 647, "name": "code", "kind": 1024, "kindString": "Property", @@ -8548,7 +8960,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 675, "character": 2 } ], @@ -8558,7 +8970,7 @@ } }, { - "id": 625, + "id": 645, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -8569,7 +8981,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 669, "character": 2 } ], @@ -8583,13 +8995,17 @@ { "title": "Properties", "kind": 1024, - "children": [626, 627, 625] + "children": [ + 646, + 647, + 645 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 30 } ] @@ -8604,7 +9020,7 @@ "typeArguments": [ { "type": "reference", - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse" } ], @@ -8620,13 +9036,21 @@ { "title": "Methods", "kind": 2048, - "children": [708, 717, 705, 722, 720, 714, 711] + "children": [ + 728, + 737, + 725, + 742, + 740, + 734, + 731 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 789, + "line": 815, "character": 17 } ] @@ -8642,7 +9066,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 410, + "line": 411, "character": 8 } ], @@ -8654,7 +9078,7 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user via a third-party provider." + "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." }, "parameters": [ { @@ -8674,7 +9098,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -8686,7 +9110,7 @@ ] }, { - "id": 136, + "id": 141, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -8694,13 +9118,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 625, + "line": 693, "character": 8 } ], "signatures": [ { - "id": 137, + "id": 142, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -8714,95 +9138,6 @@ { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 139, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 627, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 628, - "character": 10 - } - ], - "type": { - "type": "reference", - "id": 383, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141] - } - ] - } - } - }, - { - "id": 142, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 630, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [139, 142] - } - ] - } - }, { "type": "reflection", "declaration": { @@ -8821,7 +9156,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 633, + "line": 695, "character": 8 } ], @@ -8843,13 +9178,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 634, + "line": 696, "character": 10 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 388, + "name": "Session" } } ], @@ -8857,7 +9193,9 @@ { "title": "Properties", "kind": 1024, - "children": [146] + "children": [ + 146 + ] } ] } @@ -8872,14 +9210,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 636, + "line": 698, "character": 8 } ], "type": { - "type": "reference", - "id": 784, - "name": "AuthError" + "type": "literal", + "value": null } } ], @@ -8887,7 +9224,10 @@ { "title": "Properties", "kind": 1024, - "children": [144, 147] + "children": [ + 144, + 147 + ] } ] } @@ -8910,7 +9250,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 639, + "line": 701, "character": 8 } ], @@ -8932,7 +9272,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 640, + "line": 702, "character": 10 } ], @@ -8946,7 +9286,9 @@ { "title": "Properties", "kind": 1024, - "children": [151] + "children": [ + 151 + ] } ] } @@ -8961,7 +9303,101 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 642, + "line": 704, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 149, + 152 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 153, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 154, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 707, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 156, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 708, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 156 + ] + } + ] + } + } + }, + { + "id": 157, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 710, "character": 8 } ], @@ -8975,7 +9411,10 @@ { "title": "Properties", "kind": 1024, - "children": [149, 152] + "children": [ + 154, + 157 + ] } ] } @@ -8991,7 +9430,7 @@ ] }, { - "id": 153, + "id": 158, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -8999,13 +9438,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 688, + "line": 756, "character": 8 } ], "signatures": [ { - "id": 154, + "id": 159, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -9015,7 +9454,7 @@ }, "parameters": [ { - "id": 155, + "id": 160, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -9036,7 +9475,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -9056,7 +9495,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 196, + "line": 197, "character": 2 } ], @@ -9075,7 +9514,7 @@ "typeArguments": [ { "type": "reference", - "id": 757, + "id": 777, "name": "InitializeResult" } ], @@ -9087,7 +9526,7 @@ ] }, { - "id": 203, + "id": 208, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -9095,13 +9534,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1000, + "line": 1071, "character": 2 } ], "signatures": [ { - "id": 204, + "id": 209, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -9111,7 +9550,7 @@ }, "parameters": [ { - "id": 205, + "id": 210, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -9122,33 +9561,33 @@ "type": { "type": "reflection", "declaration": { - "id": 206, + "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 207, + "id": 212, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 208, + "id": 213, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 322, + "id": 327, "name": "AuthChangeEvent" } }, { - "id": 209, + "id": 214, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -9162,7 +9601,7 @@ }, { "type": "reference", - "id": 383, + "id": 388, "name": "Session" } ] @@ -9182,14 +9621,14 @@ "type": { "type": "reflection", "declaration": { - "id": 210, + "id": 215, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 211, + "id": 216, "name": "data", "kind": 1024, "kindString": "Property", @@ -9197,21 +9636,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1001, + "line": 1072, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 212, + "id": 217, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 213, + "id": 218, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -9219,23 +9658,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1001, + "line": 1072, "character": 12 } ], "type": { "type": "reference", - "id": 457, + "id": 464, "name": "Subscription", "dereferenced": { - "id": 457, + "id": 464, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 458, + "id": 465, "name": "id", "kind": 1024, "kindString": "Property", @@ -9246,7 +9685,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 329, "character": 2 } ], @@ -9256,7 +9695,7 @@ } }, { - "id": 459, + "id": 466, "name": "callback", "kind": 2048, "kindString": "Method", @@ -9264,13 +9703,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 325, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 460, + "id": 467, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -9280,17 +9719,17 @@ }, "parameters": [ { - "id": 461, + "id": 468, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 322, + "id": 327, "name": "AuthChangeEvent", "dereferenced": { - "id": 322, + "id": 327, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -9298,7 +9737,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 25, + "line": 26, "character": 12 } ], @@ -9330,7 +9769,7 @@ "value": "USER_UPDATED" }, { - "id": 321, + "id": 326, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -9338,7 +9777,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, + "line": 24, "character": 12 } ], @@ -9353,7 +9792,7 @@ } }, { - "id": 462, + "id": 469, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -9367,7 +9806,7 @@ }, { "type": "reference", - "id": 383, + "id": 388, "name": "Session" } ] @@ -9382,7 +9821,7 @@ ] }, { - "id": 463, + "id": 470, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -9390,13 +9829,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 329, + "line": 337, "character": 2 } ], "signatures": [ { - "id": 464, + "id": 471, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -9416,18 +9855,23 @@ { "title": "Properties", "kind": 1024, - "children": [458] + "children": [ + 465 + ] }, { "title": "Methods", "kind": 2048, - "children": [459, 463] + "children": [ + 466, + 470 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 317, + "line": 325, "character": 17 } ] @@ -9439,7 +9883,9 @@ { "title": "Properties", "kind": 1024, - "children": [213] + "children": [ + 218 + ] } ] } @@ -9450,7 +9896,9 @@ { "title": "Properties", "kind": 1024, - "children": [211] + "children": [ + 216 + ] } ] } @@ -9459,7 +9907,46 @@ ] }, { - "id": 175, + "id": 136, + "name": "reauthenticate", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 626, + "character": 8 + } + ], + "signatures": [ + { + "id": 137, + "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": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 180, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -9467,13 +9954,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 834, + "line": 902, "character": 8 } ], "signatures": [ { - "id": 176, + "id": 181, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -9483,7 +9970,7 @@ }, "parameters": [ { - "id": 177, + "id": 182, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -9496,14 +9983,14 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 179, + "id": 184, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -9511,7 +9998,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 834, + "line": 902, "character": 42 } ], @@ -9525,7 +10012,9 @@ { "title": "Properties", "kind": 1024, - "children": [179] + "children": [ + 184 + ] } ] } @@ -9537,7 +10026,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -9549,7 +10038,389 @@ ] }, { - "id": 217, + "id": 138, + "name": "resend", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 651, + "character": 8 + } + ], + "signatures": [ + { + "id": 139, + "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": 140, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 562, + "name": "ResendParams", + "dereferenced": { + "id": 562, + "name": "ResendParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 516, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 563, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 565, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 519, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 566, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 567, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 568, + "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": 522, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 568 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 16 + } + ] + } + } + }, + { + "id": 564, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 518, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 561, + "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": [ + 565, + 566, + 564 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 517, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 569, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 572, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 573, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 574, + "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": 530, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 574 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 16 + } + ] + } + } + }, + { + "id": 571, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 527, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 570, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 526, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 560, + "name": "MobileOtpType" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "phone" + } + ] + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 572, + 571, + 570 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 525, + "character": 4 + } + ] + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 342, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 222, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -9557,13 +10428,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1040, + "line": 1111, "character": 8 } ], "signatures": [ { - "id": 218, + "id": 223, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -9573,7 +10444,7 @@ }, "parameters": [ { - "id": 219, + "id": 224, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -9587,7 +10458,7 @@ } }, { - "id": 220, + "id": 225, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9595,14 +10466,14 @@ "type": { "type": "reflection", "declaration": { - "id": 221, + "id": 226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 223, + "id": 228, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -9615,7 +10486,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1044, + "line": 1115, "character": 6 } ], @@ -9625,7 +10496,7 @@ } }, { - "id": 222, + "id": 227, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -9638,7 +10509,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1043, + "line": 1114, "character": 6 } ], @@ -9652,7 +10523,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 228, + 227 + ] } ] } @@ -9669,14 +10543,14 @@ { "type": "reflection", "declaration": { - "id": 224, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 230, "name": "data", "kind": 1024, "kindString": "Property", @@ -9684,14 +10558,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1048, + "line": 1119, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 226, + "id": 231, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9700,7 +10574,7 @@ } }, { - "id": 227, + "id": 232, "name": "error", "kind": 1024, "kindString": "Property", @@ -9708,7 +10582,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1049, + "line": 1120, "character": 8 } ], @@ -9722,7 +10596,10 @@ { "title": "Properties", "kind": 1024, - "children": [225, 227] + "children": [ + 230, + 232 + ] } ] } @@ -9730,14 +10607,14 @@ { "type": "reflection", "declaration": { - "id": 228, + "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 229, + "id": 234, "name": "data", "kind": 1024, "kindString": "Property", @@ -9745,7 +10622,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1051, + "line": 1122, "character": 8 } ], @@ -9755,7 +10632,7 @@ } }, { - "id": 230, + "id": 235, "name": "error", "kind": 1024, "kindString": "Property", @@ -9763,13 +10640,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1051, + "line": 1122, "character": 20 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -9778,7 +10655,10 @@ { "title": "Properties", "kind": 1024, - "children": [229, 230] + "children": [ + 234, + 235 + ] } ] } @@ -9794,7 +10674,7 @@ ] }, { - "id": 169, + "id": 174, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -9802,13 +10682,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 770, + "line": 838, "character": 8 } ], "signatures": [ { - "id": 170, + "id": 175, "name": "setSession", "kind": 4096, "kindString": "Call signature", @@ -9818,7 +10698,7 @@ }, "parameters": [ { - "id": 171, + "id": 176, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -9829,14 +10709,14 @@ "type": { "type": "reflection", "declaration": { - "id": 172, + "id": 177, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 173, + "id": 178, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -9844,7 +10724,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 771, + "line": 839, "character": 4 } ], @@ -9854,7 +10734,7 @@ } }, { - "id": 174, + "id": 179, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -9862,7 +10742,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 772, + "line": 840, "character": 4 } ], @@ -9876,7 +10756,10 @@ { "title": "Properties", "kind": 1024, - "children": [173, 174] + "children": [ + 178, + 179 + ] } ] } @@ -9888,7 +10771,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -9908,7 +10791,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 440, + "line": 441, "character": 8 } ], @@ -9937,10 +10820,10 @@ "flags": {}, "type": { "type": "reference", - "id": 528, + "id": 535, "name": "SignInWithIdTokenCredentials", "dereferenced": { - "id": 528, + "id": 535, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -9948,21 +10831,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 463, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 529, + "id": 536, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 532, + "id": 539, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -9975,7 +10858,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 463, + "line": 471, "character": 2 } ], @@ -9985,7 +10868,7 @@ } }, { - "id": 533, + "id": 540, "name": "options", "kind": 1024, "kindString": "Property", @@ -9995,21 +10878,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 472, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 534, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 535, + "id": 542, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -10022,7 +10905,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 466, + "line": 474, "character": 4 } ], @@ -10036,13 +10919,15 @@ { "title": "Properties", "kind": 1024, - "children": [535] + "children": [ + 542 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 472, "character": 12 } ] @@ -10050,7 +10935,7 @@ } }, { - "id": 530, + "id": 537, "name": "provider", "kind": 1024, "kindString": "Property", @@ -10061,7 +10946,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 459, + "line": 467, "character": 2 } ], @@ -10080,7 +10965,7 @@ } }, { - "id": 531, + "id": 538, "name": "token", "kind": 1024, "kindString": "Property", @@ -10091,7 +10976,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 461, + "line": 469, "character": 2 } ], @@ -10105,13 +10990,18 @@ { "title": "Properties", "kind": 1024, - "children": [532, 533, 530, 531] + "children": [ + 539, + 540, + 537, + 538 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 463, "character": 43 } ] @@ -10126,7 +11016,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -10146,7 +11036,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 396, + "line": 397, "character": 8 } ], @@ -10169,10 +11059,10 @@ "flags": {}, "type": { "type": "reference", - "id": 516, + "id": 523, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 516, + "id": 523, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -10180,21 +11070,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 448, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 517, + "id": 524, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 526, "name": "options", "kind": 1024, "kindString": "Property", @@ -10204,21 +11094,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 443, + "line": 451, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 520, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 523, + "id": 530, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -10231,14 +11121,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 449, + "line": 457, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 524, + "id": 531, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10246,19 +11136,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 449, + "line": 457, "character": 18 } ], "indexSignature": { - "id": 525, + "id": 532, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 526, + "id": 533, "name": "key", "kind": 32768, "flags": {}, @@ -10277,7 +11167,7 @@ } }, { - "id": 521, + "id": 528, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -10290,7 +11180,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 445, + "line": 453, "character": 4 } ], @@ -10300,7 +11190,7 @@ } }, { - "id": 522, + "id": 529, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -10313,7 +11203,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 447, + "line": 455, "character": 4 } ], @@ -10323,7 +11213,7 @@ } }, { - "id": 527, + "id": 534, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -10336,7 +11226,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 451, + "line": 459, "character": 4 } ], @@ -10350,13 +11240,18 @@ { "title": "Properties", "kind": 1024, - "children": [523, 521, 522, 527] + "children": [ + 530, + 528, + 529, + 534 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 443, + "line": 451, "character": 12 } ] @@ -10364,7 +11259,7 @@ } }, { - "id": 518, + "id": 525, "name": "provider", "kind": 1024, "kindString": "Property", @@ -10375,16 +11270,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 442, + "line": 450, "character": 2 } ], "type": { "type": "reference", - "id": 320, + "id": 325, "name": "Provider", "dereferenced": { - "id": 320, + "id": 325, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -10465,6 +11360,10 @@ { "type": "literal", "value": "workos" + }, + { + "type": "literal", + "value": "zoom" } ] } @@ -10476,13 +11375,16 @@ { "title": "Properties", "kind": 1024, - "children": [519, 518] + "children": [ + 526, + 525 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 448, "character": 41 } ] @@ -10497,7 +11399,7 @@ "typeArguments": [ { "type": "reference", - "id": 350, + "id": 355, "name": "OAuthResponse" } ], @@ -10517,7 +11419,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 488, + "line": 489, "character": 8 } ], @@ -10541,10 +11443,10 @@ "flags": {}, "type": { "type": "reference", - "id": 498, + "id": 505, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 498, + "id": 505, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -10552,7 +11454,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 401, + "line": 409, "character": 12 } ], @@ -10562,14 +11464,14 @@ { "type": "reflection", "declaration": { - "id": 499, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 500, + "id": 507, "name": "email", "kind": 1024, "kindString": "Property", @@ -10580,7 +11482,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 404, + "line": 412, "character": 6 } ], @@ -10590,7 +11492,7 @@ } }, { - "id": 501, + "id": 508, "name": "options", "kind": 1024, "kindString": "Property", @@ -10600,175 +11502,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 413, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 502, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 506, - "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": 417, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 505, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 415, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 503, - "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": 407, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 504, - "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": 409, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [506, 505, 503, 504] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 405, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [500, 501] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 402, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 507, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 509, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 423, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 510, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10788,7 +11529,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 425, "character": 8 } ], @@ -10798,7 +11539,176 @@ } }, { - "id": 514, + "id": 512, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 423, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 510, + "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": 415, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 511, + "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": 417, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 513, + 512, + 510, + 511 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 413, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 507, + 508 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 410, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 514, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 516, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 431, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 517, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 520, + "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": 441, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 521, "name": "channel", "kind": 1024, "kindString": "Property", @@ -10811,7 +11721,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 435, + "line": 443, "character": 8 } ], @@ -10830,7 +11740,7 @@ } }, { - "id": 512, + "id": 519, "name": "data", "kind": 1024, "kindString": "Property", @@ -10844,7 +11754,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 431, + "line": 439, "character": 8 } ], @@ -10854,7 +11764,7 @@ } }, { - "id": 511, + "id": 518, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -10867,7 +11777,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 425, + "line": 433, "character": 8 } ], @@ -10881,13 +11791,18 @@ { "title": "Properties", "kind": 1024, - "children": [513, 514, 512, 511] + "children": [ + 520, + 521, + 519, + 518 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 423, + "line": 431, "character": 16 } ] @@ -10895,7 +11810,7 @@ } }, { - "id": 508, + "id": 515, "name": "phone", "kind": 1024, "kindString": "Property", @@ -10906,7 +11821,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 422, + "line": 430, "character": 6 } ], @@ -10920,13 +11835,16 @@ { "title": "Properties", "kind": 1024, - "children": [509, 508] + "children": [ + 516, + 515 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 420, + "line": 428, "character": 4 } ] @@ -10943,7 +11861,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -10963,7 +11881,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 346, + "line": 347, "character": 8 } ], @@ -10987,10 +11905,10 @@ "flags": {}, "type": { "type": "reference", - "id": 484, + "id": 491, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 484, + "id": 491, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -10998,7 +11916,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 373, + "line": 381, "character": 12 } ], @@ -11008,14 +11926,14 @@ { "type": "reflection", "declaration": { - "id": 485, + "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 486, + "id": 493, "name": "email", "kind": 1024, "kindString": "Property", @@ -11026,7 +11944,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 376, + "line": 384, "character": 6 } ], @@ -11036,7 +11954,7 @@ } }, { - "id": 488, + "id": 495, "name": "options", "kind": 1024, "kindString": "Property", @@ -11046,126 +11964,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 379, + "line": 387, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 489, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 490, - "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": 381, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [490] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 379, - "character": 16 - } - ] - } - } - }, - { - "id": 487, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 378, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [486, 488, 487] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 374, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 491, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 494, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 389, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 495, + "id": 496, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -11185,7 +11991,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 397, + "line": 389, "character": 8 } ], @@ -11193,43 +11999,21 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 496, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 395, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [497, 496] + "children": [ + 497 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 389, + "line": 387, "character": 16 } ] @@ -11237,7 +12021,7 @@ } }, { - "id": 493, + "id": 494, "name": "password", "kind": 1024, "kindString": "Property", @@ -11245,27 +12029,6 @@ "comment": { "shortText": "The user's password." }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 388, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 492, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -11283,13 +12046,181 @@ { "title": "Properties", "kind": 1024, - "children": [494, 493, 492] + "children": [ + 493, + 495, + 494 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 384, + "line": 382, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 498, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 501, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 397, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 502, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 504, + "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": 405, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 503, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 403, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 504, + 503 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 397, + "character": 16 + } + ] + } + } + }, + { + "id": 500, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 396, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 499, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 394, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 501, + 500, + 499 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 392, "character": 4 } ] @@ -11306,7 +12237,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -11326,7 +12257,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 596, + "line": 597, "character": 8 } ], @@ -11350,10 +12281,10 @@ "flags": {}, "type": { "type": "reference", - "id": 555, + "id": 575, "name": "SignInWithSSO", "dereferenced": { - "id": 555, + "id": 575, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -11361,7 +12292,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 508, + "line": 534, "character": 12 } ], @@ -11371,14 +12302,14 @@ { "type": "reflection", "declaration": { - "id": 556, + "id": 576, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 558, + "id": 578, "name": "options", "kind": 1024, "kindString": "Property", @@ -11388,21 +12319,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 539, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 559, + "id": 579, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 561, + "id": 581, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -11415,7 +12346,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 517, + "line": 543, "character": 8 } ], @@ -11425,7 +12356,7 @@ } }, { - "id": 560, + "id": 580, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -11438,7 +12369,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 515, + "line": 541, "character": 8 } ], @@ -11452,13 +12383,16 @@ { "title": "Properties", "kind": 1024, - "children": [561, 560] + "children": [ + 581, + 580 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 539, "character": 16 } ] @@ -11466,7 +12400,7 @@ } }, { - "id": 557, + "id": 577, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -11477,7 +12411,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 537, "character": 6 } ], @@ -11491,13 +12425,16 @@ { "title": "Properties", "kind": 1024, - "children": [558, 557] + "children": [ + 578, + 577 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 509, + "line": 535, "character": 4 } ] @@ -11506,14 +12443,14 @@ { "type": "reflection", "declaration": { - "id": 562, + "id": 582, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 563, + "id": 583, "name": "domain", "kind": 1024, "kindString": "Property", @@ -11524,7 +12461,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 522, + "line": 548, "character": 6 } ], @@ -11534,7 +12471,7 @@ } }, { - "id": 564, + "id": 584, "name": "options", "kind": 1024, "kindString": "Property", @@ -11544,21 +12481,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 524, + "line": 550, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 565, + "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 567, + "id": 587, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -11571,7 +12508,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 528, + "line": 554, "character": 8 } ], @@ -11581,7 +12518,7 @@ } }, { - "id": 566, + "id": 586, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -11594,7 +12531,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 526, + "line": 552, "character": 8 } ], @@ -11608,13 +12545,16 @@ { "title": "Properties", "kind": 1024, - "children": [567, 566] + "children": [ + 587, + 586 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 524, + "line": 550, "character": 16 } ] @@ -11626,13 +12566,16 @@ { "title": "Properties", "kind": 1024, - "children": [563, 564] + "children": [ + 583, + 584 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 520, + "line": 546, "character": 4 } ] @@ -11649,7 +12592,7 @@ "typeArguments": [ { "type": "reference", - "id": 363, + "id": 368, "name": "SSOResponse" } ], @@ -11661,7 +12604,7 @@ ] }, { - "id": 199, + "id": 204, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -11669,13 +12612,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 974, + "line": 1045, "character": 8 } ], "signatures": [ { - "id": 200, + "id": 205, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -11690,14 +12633,14 @@ { "type": "reflection", "declaration": { - "id": 201, + "id": 206, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 202, + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -11705,7 +12648,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 974, + "line": 1045, "character": 29 } ], @@ -11718,7 +12661,7 @@ }, { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } ] @@ -11729,7 +12672,9 @@ { "title": "Properties", "kind": 1024, - "children": [202] + "children": [ + 207 + ] } ] } @@ -11751,7 +12696,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 267, + "line": 268, "character": 8 } ], @@ -11776,10 +12721,10 @@ "flags": {}, "type": { "type": "reference", - "id": 467, + "id": 474, "name": "SignUpWithPasswordCredentials", "dereferenced": { - "id": 467, + "id": 474, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -11787,7 +12732,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 336, + "line": 344, "character": 12 } ], @@ -11797,14 +12742,14 @@ { "type": "reflection", "declaration": { - "id": 468, + "id": 475, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 469, + "id": 476, "name": "email", "kind": 1024, "kindString": "Property", @@ -11815,7 +12760,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 339, + "line": 347, "character": 6 } ], @@ -11825,7 +12770,7 @@ } }, { - "id": 471, + "id": 478, "name": "options", "kind": 1024, "kindString": "Property", @@ -11835,173 +12780,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 342, + "line": 350, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 472, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 475, - "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": 352, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 474, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 473, - "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": 344, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [475, 474, 473] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 16 - } - ] - } - } - }, - { - "id": 470, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [469, 471, 470] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 476, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 479, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 360, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 480, + "id": 479, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12016,12 +12802,12 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 368, + "line": 360, "character": 8 } ], @@ -12031,7 +12817,174 @@ } }, { - "id": 483, + "id": 481, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 358, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 480, + "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": 352, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 482, + 481, + 480 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 350, + "character": 16 + } + ] + } + } + }, + { + "id": 477, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 349, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 476, + 478, + 477 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 345, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 483, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 486, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 487, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 489, + "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": 376, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 490, "name": "channel", "kind": 1024, "kindString": "Property", @@ -12044,7 +12997,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 370, + "line": 378, "character": 8 } ], @@ -12063,7 +13016,7 @@ } }, { - "id": 481, + "id": 488, "name": "data", "kind": 1024, "kindString": "Property", @@ -12077,7 +13030,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 374, "character": 8 } ], @@ -12091,13 +13044,17 @@ { "title": "Properties", "kind": 1024, - "children": [482, 483, 481] + "children": [ + 489, + 490, + 488 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 360, + "line": 368, "character": 16 } ] @@ -12105,7 +13062,7 @@ } }, { - "id": 478, + "id": 485, "name": "password", "kind": 1024, "kindString": "Property", @@ -12116,7 +13073,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 367, "character": 6 } ], @@ -12126,7 +13083,7 @@ } }, { - "id": 477, + "id": 484, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12137,7 +13094,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 357, + "line": 365, "character": 6 } ], @@ -12151,13 +13108,17 @@ { "title": "Properties", "kind": 1024, - "children": [479, 478, 477] + "children": [ + 486, + 485, + 484 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 355, + "line": 363, "character": 4 } ] @@ -12174,7 +13135,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -12186,7 +13147,7 @@ ] }, { - "id": 279, + "id": 284, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", @@ -12194,13 +13155,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1346, + "line": 1415, "character": 8 } ], "signatures": [ { - "id": 280, + "id": 285, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -12225,7 +13186,7 @@ ] }, { - "id": 281, + "id": 286, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", @@ -12233,13 +13194,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1359, + "line": 1428, "character": 8 } ], "signatures": [ { - "id": 282, + "id": 287, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -12264,7 +13225,7 @@ ] }, { - "id": 156, + "id": 161, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -12272,13 +13233,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 717, + "line": 785, "character": 8 } ], "signatures": [ { - "id": 157, + "id": 162, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -12288,24 +13249,24 @@ }, "parameters": [ { - "id": 158, + "id": 163, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes", "dereferenced": { - "id": 443, + "id": 448, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 447, + "id": 453, "name": "data", "kind": 1024, "kindString": "Property", @@ -12319,7 +13280,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 264, + "line": 272, "character": 2 } ], @@ -12329,7 +13290,7 @@ } }, { - "id": 444, + "id": 449, "name": "email", "kind": 1024, "kindString": "Property", @@ -12342,7 +13303,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -12352,7 +13313,31 @@ } }, { - "id": 446, + "id": 452, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, "name": "password", "kind": 1024, "kindString": "Property", @@ -12365,7 +13350,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -12375,7 +13360,7 @@ } }, { - "id": 445, + "id": 450, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12388,7 +13373,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -12402,13 +13387,19 @@ { "title": "Properties", "kind": 1024, - "children": [447, 444, 446, 445] + "children": [ + 453, + 449, + 452, + 451, + 450 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 242, + "line": 243, "character": 17 } ] @@ -12416,7 +13407,7 @@ } }, { - "id": 159, + "id": 164, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12424,14 +13415,14 @@ "type": { "type": "reflection", "declaration": { - "id": 160, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 161, + "id": 166, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -12441,7 +13432,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 720, + "line": 788, "character": 6 } ], @@ -12455,7 +13446,9 @@ { "title": "Properties", "kind": 1024, - "children": [161] + "children": [ + 166 + ] } ] } @@ -12468,7 +13461,7 @@ "typeArguments": [ { "type": "reference", - "id": 372, + "id": 377, "name": "UserResponse" } ], @@ -12488,7 +13481,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 543, + "line": 544, "character": 8 } ], @@ -12511,10 +13504,10 @@ "flags": {}, "type": { "type": "reference", - "id": 536, + "id": 543, "name": "VerifyOtpParams", "dereferenced": { - "id": 536, + "id": 543, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -12522,7 +13515,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 470, + "line": 478, "character": 12 } ], @@ -12530,14 +13523,14 @@ "type": "union", "types": [ { - "id": 537, + "id": 544, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 541, + "id": 548, "name": "options", "kind": 1024, "kindString": "Property", @@ -12547,21 +13540,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 478, + "line": 486, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 542, + "id": 549, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 551, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12580,7 +13573,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 495, "character": 4 } ], @@ -12590,7 +13583,7 @@ } }, { - "id": 543, + "id": 550, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -12603,7 +13596,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 480, + "line": 488, "character": 4 } ], @@ -12617,14 +13610,17 @@ { "title": "Properties", "kind": 1024, - "children": [544, 543] + "children": [ + 551, + 550 + ] } ] } } }, { - "id": 538, + "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12635,7 +13631,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 473, + "line": 481, "character": 2 } ], @@ -12645,7 +13641,7 @@ } }, { - "id": 539, + "id": 546, "name": "token", "kind": 1024, "kindString": "Property", @@ -12656,7 +13652,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 475, + "line": 483, "character": 2 } ], @@ -12666,7 +13662,7 @@ } }, { - "id": 540, + "id": 547, "name": "type", "kind": 1024, "kindString": "Property", @@ -12677,16 +13673,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 477, + "line": 485, "character": 2 } ], "type": { "type": "reference", - "id": 553, + "id": 560, "name": "MobileOtpType", "dereferenced": { - "id": 553, + "id": 560, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -12694,7 +13690,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 513, "character": 12 } ], @@ -12719,26 +13715,31 @@ { "title": "Properties", "kind": 1024, - "children": [541, 538, 539, 540] + "children": [ + 548, + 545, + 546, + 547 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 479, "character": 17 } ] }, { - "id": 545, + "id": 552, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 546, + "id": 553, "name": "email", "kind": 1024, "kindString": "Property", @@ -12749,7 +13750,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 492, + "line": 500, "character": 2 } ], @@ -12759,7 +13760,7 @@ } }, { - "id": 549, + "id": 556, "name": "options", "kind": 1024, "kindString": "Property", @@ -12769,21 +13770,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 497, + "line": 505, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 550, + "id": 557, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 559, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12796,7 +13797,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 501, + "line": 509, "character": 4 } ], @@ -12806,7 +13807,7 @@ } }, { - "id": 551, + "id": 558, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -12819,7 +13820,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 499, + "line": 507, "character": 4 } ], @@ -12833,14 +13834,17 @@ { "title": "Properties", "kind": 1024, - "children": [552, 551] + "children": [ + 559, + 558 + ] } ] } } }, { - "id": 547, + "id": 554, "name": "token", "kind": 1024, "kindString": "Property", @@ -12851,7 +13855,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 494, + "line": 502, "character": 2 } ], @@ -12861,7 +13865,7 @@ } }, { - "id": 548, + "id": 555, "name": "type", "kind": 1024, "kindString": "Property", @@ -12872,16 +13876,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 496, + "line": 504, "character": 2 } ], "type": { "type": "reference", - "id": 554, + "id": 561, "name": "EmailOtpType", "dereferenced": { - "id": 554, + "id": 561, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -12889,7 +13893,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 514, "character": 12 } ], @@ -12930,13 +13934,18 @@ { "title": "Properties", "kind": 1024, - "children": [546, 549, 547, 548] + "children": [ + 553, + 556, + 554, + 555 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 490, + "line": 498, "character": 17 } ] @@ -12952,7 +13961,7 @@ "typeArguments": [ { "type": "reference", - "id": 337, + "id": 342, "name": "AuthResponse" } ], @@ -12968,32 +13977,56 @@ { "title": "Constructors", "kind": 512, - "children": [78] + "children": [ + 78 + ] }, { "title": "Properties", "kind": 1024, - "children": [81, 82] + "children": [ + 81, + 82 + ] }, { "title": "Methods", "kind": 2048, "children": [ - 121, 136, 153, 108, 203, 175, 217, 169, 124, 118, 127, 115, 133, 199, 112, 279, 281, - 156, 130 + 121, + 141, + 158, + 108, + 208, + 136, + 180, + 138, + 222, + 174, + 124, + 118, + 127, + 115, + 133, + 204, + 112, + 284, + 286, + 161, + 130 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 92, + "line": 93, "character": 21 } ] }, { - "id": 392, + "id": 397, "name": "AMREntry", "kind": 256, "kindString": "Interface", @@ -13010,7 +14043,7 @@ }, "children": [ { - "id": 393, + "id": 398, "name": "method", "kind": 1024, "kindString": "Property", @@ -13021,7 +14054,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 160, + "line": 161, "character": 2 } ], @@ -13031,7 +14064,7 @@ } }, { - "id": 394, + "id": 399, "name": "timestamp", "kind": 1024, "kindString": "Property", @@ -13042,7 +14075,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 166, + "line": 167, "character": 2 } ], @@ -13056,26 +14089,29 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394] + "children": [ + 398, + 399 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 158, + "line": 159, "character": 17 } ] }, { - "id": 448, + "id": 454, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 450, + "id": 456, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -13089,7 +14125,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 288, + "line": 296, "character": 2 } ], @@ -13099,7 +14135,7 @@ } }, { - "id": 453, + "id": 459, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -13113,7 +14149,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 322, "character": 2 } ], @@ -13123,7 +14159,7 @@ } }, { - "id": 455, + "id": 462, "name": "email", "kind": 1024, "kindString": "Property", @@ -13136,7 +14172,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -13150,7 +14186,7 @@ } }, { - "id": 451, + "id": 457, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -13164,7 +14200,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 303, "character": 2 } ], @@ -13174,7 +14210,35 @@ } }, { - "id": 454, + "id": 461, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 460, "name": "password", "kind": 1024, "kindString": "Property", @@ -13187,7 +14251,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -13201,7 +14265,7 @@ } }, { - "id": 456, + "id": 463, "name": "phone", "kind": 1024, "kindString": "Property", @@ -13214,7 +14278,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -13228,7 +14292,7 @@ } }, { - "id": 452, + "id": 458, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -13242,7 +14306,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 302, + "line": 310, "character": 2 } ], @@ -13252,7 +14316,7 @@ } }, { - "id": 449, + "id": 455, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -13266,7 +14330,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 286, "character": 2 } ], @@ -13280,13 +14344,23 @@ { "title": "Properties", "kind": 1024, - "children": [450, 453, 455, 451, 454, 456, 452, 449] + "children": [ + 456, + 459, + 462, + 457, + 461, + 460, + 463, + 458, + 455 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 267, + "line": 275, "character": 17 } ], @@ -13296,7 +14370,7 @@ "typeArguments": [ { "type": "reference", - "id": 443, + "id": 448, "name": "UserAttributes" }, { @@ -13311,7 +14385,7 @@ ] }, { - "id": 406, + "id": 411, "name": "Factor", "kind": 256, "kindString": "Interface", @@ -13335,7 +14409,7 @@ }, "children": [ { - "id": 411, + "id": 416, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -13343,7 +14417,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 204, + "line": 205, "character": 2 } ], @@ -13353,7 +14427,7 @@ } }, { - "id": 409, + "id": 414, "name": "factor_type", "kind": 1024, "kindString": "Property", @@ -13364,7 +14438,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 199, + "line": 200, "character": 2 } ], @@ -13374,7 +14448,7 @@ } }, { - "id": 408, + "id": 413, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -13387,7 +14461,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 193, + "line": 194, "character": 2 } ], @@ -13397,7 +14471,7 @@ } }, { - "id": 407, + "id": 412, "name": "id", "kind": 1024, "kindString": "Property", @@ -13408,7 +14482,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 190, + "line": 191, "character": 2 } ], @@ -13418,7 +14492,7 @@ } }, { - "id": 410, + "id": 415, "name": "status", "kind": 1024, "kindString": "Property", @@ -13429,7 +14503,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 202, + "line": 203, "character": 2 } ], @@ -13448,7 +14522,7 @@ } }, { - "id": 412, + "id": 417, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -13456,7 +14530,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 205, + "line": 206, "character": 2 } ], @@ -13470,26 +14544,33 @@ { "title": "Properties", "kind": 1024, - "children": [411, 409, 408, 407, 410, 412] + "children": [ + 416, + 414, + 413, + 412, + 415, + 417 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 188, + "line": 189, "character": 17 } ] }, { - "id": 590, + "id": 610, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 591, + "id": 611, "name": "data", "kind": 1024, "kindString": "Property", @@ -13503,7 +14584,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 570, + "line": 596, "character": 2 } ], @@ -13513,7 +14594,7 @@ } }, { - "id": 592, + "id": 612, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -13526,7 +14607,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 572, + "line": 598, "character": 2 } ], @@ -13540,19 +14621,22 @@ { "title": "Properties", "kind": 1024, - "children": [591, 592] + "children": [ + 611, + 612 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 564, + "line": 590, "character": 17 } ] }, { - "id": 749, + "id": 769, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -13568,14 +14652,14 @@ }, "children": [ { - "id": 753, + "id": 773, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 754, + "id": 774, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -13595,17 +14679,17 @@ }, "parameters": [ { - "id": 755, + "id": 775, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -13621,21 +14705,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "id", "kind": 1024, "kindString": "Property", @@ -13646,7 +14730,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 870, + "line": 896, "character": 2 } ], @@ -13656,7 +14740,7 @@ } }, { - "id": 736, + "id": 756, "name": "userId", "kind": 1024, "kindString": "Property", @@ -13667,7 +14751,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 873, + "line": 899, "character": 2 } ], @@ -13681,13 +14765,16 @@ { "title": "Properties", "kind": 1024, - "children": [735, 736] + "children": [ + 755, + 756 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 45 } ] @@ -13702,7 +14789,7 @@ "typeArguments": [ { "type": "reference", - "id": 724, + "id": 744, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -13714,14 +14801,14 @@ ] }, { - "id": 750, + "id": 770, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 751, + "id": 771, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -13731,17 +14818,17 @@ }, "parameters": [ { - "id": 752, + "id": 772, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -13757,21 +14844,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 747, + "id": 767, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 768, "name": "userId", "kind": 1024, "kindString": "Property", @@ -13782,7 +14869,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 920, "character": 2 } ], @@ -13796,13 +14883,15 @@ { "title": "Properties", "kind": 1024, - "children": [748] + "children": [ + 768 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 44 } ] @@ -13817,7 +14906,7 @@ "typeArguments": [ { "type": "reference", - "id": 737, + "id": 757, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -13833,19 +14922,22 @@ { "title": "Methods", "kind": 2048, - "children": [753, 750] + "children": [ + 773, + 770 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 902, + "line": 928, "character": 17 } ] }, { - "id": 704, + "id": 724, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -13855,14 +14947,14 @@ }, "children": [ { - "id": 708, + "id": 728, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 709, + "id": 729, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -13872,17 +14964,17 @@ }, "parameters": [ { - "id": 710, + "id": 730, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 628, + "id": 648, "name": "MFAChallengeParams", "dereferenced": { - "id": 628, + "id": 648, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -13890,21 +14982,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 630, + "id": 650, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -13915,7 +15007,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 680, "character": 2 } ], @@ -13929,13 +15021,15 @@ { "title": "Properties", "kind": 1024, - "children": [630] + "children": [ + 650 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 33 } ] @@ -13950,7 +15044,7 @@ "typeArguments": [ { "type": "reference", - "id": 672, + "id": 692, "name": "AuthMFAChallengeResponse" } ], @@ -13962,14 +15056,14 @@ ] }, { - "id": 717, + "id": 737, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 718, + "id": 738, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -13979,17 +15073,17 @@ }, "parameters": [ { - "id": 719, + "id": 739, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -13997,21 +15091,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 634, + "id": 654, "name": "code", "kind": 1024, "kindString": "Property", @@ -14022,7 +15116,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 661, + "line": 687, "character": 2 } ], @@ -14032,7 +15126,7 @@ } }, { - "id": 633, + "id": 653, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -14043,7 +15137,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 685, "character": 2 } ], @@ -14057,13 +15151,16 @@ { "title": "Properties", "kind": 1024, - "children": [634, 633] + "children": [ + 654, + 653 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 42 } ] @@ -14078,7 +15175,7 @@ "typeArguments": [ { "type": "reference", - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse" } ], @@ -14090,14 +15187,14 @@ ] }, { - "id": 705, + "id": 725, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 706, + "id": 726, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -14108,17 +15205,17 @@ }, "parameters": [ { - "id": 707, + "id": 727, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 615, + "id": 635, "name": "MFAEnrollParams", "dereferenced": { - "id": 615, + "id": 635, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -14126,21 +15223,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 636, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 637, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -14151,7 +15248,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 629, + "line": 655, "character": 2 } ], @@ -14161,7 +15258,7 @@ } }, { - "id": 619, + "id": 639, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -14174,7 +15271,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 633, + "line": 659, "character": 2 } ], @@ -14184,7 +15281,7 @@ } }, { - "id": 618, + "id": 638, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -14197,7 +15294,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 631, + "line": 657, "character": 2 } ], @@ -14211,13 +15308,17 @@ { "title": "Properties", "kind": 1024, - "children": [617, 619, 618] + "children": [ + 637, + 639, + 638 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 30 } ] @@ -14232,7 +15333,7 @@ "typeArguments": [ { "type": "reference", - "id": 648, + "id": 668, "name": "AuthMFAEnrollResponse" } ], @@ -14244,14 +15345,14 @@ ] }, { - "id": 722, + "id": 742, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 723, + "id": 743, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -14265,7 +15366,7 @@ "typeArguments": [ { "type": "reference", - "id": 693, + "id": 713, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -14277,14 +15378,14 @@ ] }, { - "id": 720, + "id": 740, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 721, + "id": 741, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -14311,7 +15412,7 @@ "typeArguments": [ { "type": "reference", - "id": 682, + "id": 702, "name": "AuthMFAListFactorsResponse" } ], @@ -14323,14 +15424,14 @@ ] }, { - "id": 714, + "id": 734, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 715, + "id": 735, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -14340,17 +15441,17 @@ }, "parameters": [ { - "id": 716, + "id": 736, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "dereferenced": { - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -14358,21 +15459,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 621, + "id": 641, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 642, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -14383,7 +15484,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 638, + "line": 664, "character": 2 } ], @@ -14397,13 +15498,15 @@ { "title": "Properties", "kind": 1024, - "children": [622] + "children": [ + 642 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 32 } ] @@ -14418,7 +15521,7 @@ "typeArguments": [ { "type": "reference", - "id": 663, + "id": 683, "name": "AuthMFAUnenrollResponse" } ], @@ -14430,14 +15533,14 @@ ] }, { - "id": 711, + "id": 731, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 712, + "id": 732, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -14447,17 +15550,17 @@ }, "parameters": [ { - "id": 713, + "id": 733, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 623, + "id": 643, "name": "MFAVerifyParams", "dereferenced": { - "id": 623, + "id": 643, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -14465,21 +15568,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 644, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 646, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -14490,7 +15593,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 672, "character": 2 } ], @@ -14500,7 +15603,7 @@ } }, { - "id": 627, + "id": 647, "name": "code", "kind": 1024, "kindString": "Property", @@ -14511,7 +15614,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 675, "character": 2 } ], @@ -14521,7 +15624,7 @@ } }, { - "id": 625, + "id": 645, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -14532,7 +15635,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 669, "character": 2 } ], @@ -14546,13 +15649,17 @@ { "title": "Properties", "kind": 1024, - "children": [626, 627, 625] + "children": [ + 646, + 647, + 645 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 30 } ] @@ -14567,7 +15674,7 @@ "typeArguments": [ { "type": "reference", - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse" } ], @@ -14583,26 +15690,34 @@ { "title": "Methods", "kind": 2048, - "children": [708, 717, 705, 722, 720, 714, 711] + "children": [ + 728, + 737, + 725, + 742, + 740, + 734, + 731 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 789, + "line": 815, "character": 17 } ] }, { - "id": 383, + "id": 388, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 386, + "id": 391, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -14613,7 +15728,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 133, + "line": 134, "character": 2 } ], @@ -14623,7 +15738,7 @@ } }, { - "id": 389, + "id": 394, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -14636,7 +15751,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 145, + "line": 146, "character": 2 } ], @@ -14646,7 +15761,7 @@ } }, { - "id": 388, + "id": 393, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -14657,7 +15772,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 141, + "line": 142, "character": 2 } ], @@ -14667,7 +15782,7 @@ } }, { - "id": 385, + "id": 390, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", @@ -14680,7 +15795,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 129, + "line": 130, "character": 2 } ], @@ -14699,7 +15814,7 @@ } }, { - "id": 384, + "id": 389, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -14712,7 +15827,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, + "line": 125, "character": 2 } ], @@ -14731,7 +15846,7 @@ } }, { - "id": 387, + "id": 392, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -14742,7 +15857,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, + "line": 138, "character": 2 } ], @@ -14752,29 +15867,11 @@ } }, { - "id": 390, + "id": 395, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 146, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 391, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -14782,206 +15879,43 @@ "character": 2 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 396, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 148, + "character": 2 + } + ], "type": { "type": "reference", - "id": 420, + "id": 425, "name": "User", "dereferenced": { - "id": 420, + "id": 425, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 431, + "id": 436, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 228, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 219, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 413, - "name": "UserAppMetadata", - "dereferenced": { - "id": 413, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 414, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [414] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 208, - "character": 17 - } - ], - "indexSignature": { - "id": 415, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 416, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 424, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 221, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 425, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 222, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 232, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 231, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 432, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -14996,16 +15930,101 @@ }, { "id": 427, - "name": "email_change_sent_at", + "name": "app_metadata", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 224, + "line": 220, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 418, + "name": "UserAppMetadata", + "dereferenced": { + "id": 418, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 419, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 419 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 209, + "character": 17 + } + ], + "indexSignature": { + "id": 420, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 421, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 429, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, "character": 2 } ], @@ -15015,8 +16034,28 @@ } }, { - "id": 436, - "name": "email_confirmed_at", + "id": 430, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 440, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -15035,13 +16074,133 @@ } }, { - "id": 442, + "id": 439, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 232, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 437, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 230, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 432, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 234, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 447, "name": "factors", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 240, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 411, + "name": "Factor" + } + } + }, + { + "id": 426, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -15053,21 +16212,23 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, - "name": "Factor" + "id": 400, + "name": "UserIdentity" } } }, { - "id": 421, - "name": "id", + "id": 435, + "name": "invited_at", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 218, + "line": 228, "character": 2 } ], @@ -15077,8 +16238,8 @@ } }, { - "id": 441, - "name": "identities", + "id": 443, + "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { @@ -15087,22 +16248,38 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 238, + "line": 236, "character": 2 } ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 395, - "name": "UserIdentity" - } + "type": "intrinsic", + "name": "string" } }, { - "id": 430, - "name": "invited_at", + "id": 433, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 434, + "name": "new_phone", "kind": 1024, "kindString": "Property", "flags": { @@ -15122,7 +16299,27 @@ }, { "id": 438, - "name": "last_sign_in_at", + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 231, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 442, + "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -15141,87 +16338,7 @@ } }, { - "id": 428, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 225, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 429, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 226, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 433, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 230, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 437, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 234, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 426, + "id": 431, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -15231,7 +16348,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 224, "character": 2 } ], @@ -15241,33 +16358,13 @@ } }, { - "id": 439, + "id": 444, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 236, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 440, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -15281,7 +16378,27 @@ } }, { - "id": 423, + "id": 445, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 238, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 428, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -15289,16 +16406,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 221, "character": 2 } ], "type": { "type": "reference", - "id": 417, + "id": 422, "name": "UserMetadata", "dereferenced": { - "id": 417, + "id": 422, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -15306,19 +16423,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 214, "character": 17 } ], "indexSignature": { - "id": 418, + "id": 423, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 419, + "id": 424, "name": "key", "kind": 32768, "flags": {}, @@ -15342,15 +16459,35 @@ "title": "Properties", "kind": 1024, "children": [ - 431, 422, 424, 425, 435, 434, 432, 427, 436, 442, 421, 441, 430, 438, 428, 429, - 433, 437, 426, 439, 440, 423 + 436, + 427, + 429, + 430, + 440, + 439, + 437, + 432, + 441, + 447, + 426, + 446, + 435, + 443, + 433, + 434, + 438, + 442, + 431, + 444, + 445, + 428 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 217, + "line": 218, "character": 17 } ] @@ -15362,26 +16499,35 @@ { "title": "Properties", "kind": 1024, - "children": [386, 389, 388, 385, 384, 387, 390, 391] + "children": [ + 391, + 394, + 393, + 390, + 389, + 392, + 395, + 396 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 121, "character": 17 } ] }, { - "id": 457, + "id": 464, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 458, + "id": 465, "name": "id", "kind": 1024, "kindString": "Property", @@ -15392,7 +16538,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 329, "character": 2 } ], @@ -15402,7 +16548,7 @@ } }, { - "id": 459, + "id": 466, "name": "callback", "kind": 2048, "kindString": "Method", @@ -15410,13 +16556,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 325, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 460, + "id": 467, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -15426,17 +16572,17 @@ }, "parameters": [ { - "id": 461, + "id": 468, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 322, + "id": 327, "name": "AuthChangeEvent", "dereferenced": { - "id": 322, + "id": 327, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -15444,7 +16590,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 25, + "line": 26, "character": 12 } ], @@ -15476,7 +16622,7 @@ "value": "USER_UPDATED" }, { - "id": 321, + "id": 326, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -15484,7 +16630,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, + "line": 24, "character": 12 } ], @@ -15499,7 +16645,7 @@ } }, { - "id": 462, + "id": 469, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -15513,7 +16659,7 @@ }, { "type": "reference", - "id": 383, + "id": 388, "name": "Session" } ] @@ -15528,7 +16674,7 @@ ] }, { - "id": 463, + "id": 470, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -15536,13 +16682,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 329, + "line": 337, "character": 2 } ], "signatures": [ { - "id": 464, + "id": 471, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -15562,31 +16708,36 @@ { "title": "Properties", "kind": 1024, - "children": [458] + "children": [ + 465 + ] }, { "title": "Methods", "kind": 2048, - "children": [459, 463] + "children": [ + 466, + 470 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 317, + "line": 325, "character": 17 } ] }, { - "id": 465, + "id": 472, "name": "UpdatableFactorAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 466, + "id": 473, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -15594,7 +16745,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 333, + "line": 341, "character": 2 } ], @@ -15608,213 +16759,34 @@ { "title": "Properties", "kind": 1024, - "children": [466] + "children": [ + 473 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 332, + "line": 340, "character": 17 } ] }, { - "id": 420, + "id": 425, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 431, + "id": 436, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 228, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 219, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 413, - "name": "UserAppMetadata", - "dereferenced": { - "id": 413, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 414, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [414] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 208, - "character": 17 - } - ], - "indexSignature": { - "id": 415, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 416, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 424, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 221, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 425, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 222, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 232, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 231, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 432, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -15829,16 +16801,101 @@ }, { "id": 427, - "name": "email_change_sent_at", + "name": "app_metadata", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 224, + "line": 220, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 418, + "name": "UserAppMetadata", + "dereferenced": { + "id": 418, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 419, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 419 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 209, + "character": 17 + } + ], + "indexSignature": { + "id": 420, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 421, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 429, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, "character": 2 } ], @@ -15848,8 +16905,28 @@ } }, { - "id": 436, - "name": "email_confirmed_at", + "id": 430, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 440, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -15868,13 +16945,133 @@ } }, { - "id": 442, + "id": 439, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 232, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 437, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 230, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 432, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 234, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 447, "name": "factors", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 240, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 411, + "name": "Factor" + } + } + }, + { + "id": 426, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -15886,21 +17083,23 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, - "name": "Factor" + "id": 400, + "name": "UserIdentity" } } }, { - "id": 421, - "name": "id", + "id": 435, + "name": "invited_at", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 218, + "line": 228, "character": 2 } ], @@ -15910,8 +17109,8 @@ } }, { - "id": 441, - "name": "identities", + "id": 443, + "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { @@ -15920,22 +17119,38 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 238, + "line": 236, "character": 2 } ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 395, - "name": "UserIdentity" - } + "type": "intrinsic", + "name": "string" } }, { - "id": 430, - "name": "invited_at", + "id": 433, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 434, + "name": "new_phone", "kind": 1024, "kindString": "Property", "flags": { @@ -15955,7 +17170,27 @@ }, { "id": 438, - "name": "last_sign_in_at", + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 231, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 442, + "name": "phone_confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -15974,87 +17209,7 @@ } }, { - "id": 428, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 225, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 429, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 226, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 433, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 230, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 437, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 234, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 426, + "id": 431, "name": "recovery_sent_at", "kind": 1024, "kindString": "Property", @@ -16064,7 +17219,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 224, "character": 2 } ], @@ -16074,33 +17229,13 @@ } }, { - "id": 439, + "id": 444, "name": "role", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 236, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 440, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -16114,7 +17249,27 @@ } }, { - "id": 423, + "id": 445, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 238, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 428, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -16122,16 +17277,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 221, "character": 2 } ], "type": { "type": "reference", - "id": 417, + "id": 422, "name": "UserMetadata", "dereferenced": { - "id": 417, + "id": 422, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -16139,19 +17294,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 214, "character": 17 } ], "indexSignature": { - "id": 418, + "id": 423, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 419, + "id": 424, "name": "key", "kind": 32768, "flags": {}, @@ -16175,28 +17330,48 @@ "title": "Properties", "kind": 1024, "children": [ - 431, 422, 424, 425, 435, 434, 432, 427, 436, 442, 421, 441, 430, 438, 428, 429, 433, - 437, 426, 439, 440, 423 + 436, + 427, + 429, + 430, + 440, + 439, + 437, + 432, + 441, + 447, + 426, + 446, + 435, + 443, + 433, + 434, + 438, + 442, + 431, + 444, + 445, + 428 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 217, + "line": 218, "character": 17 } ] }, { - "id": 413, + "id": 418, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 414, + "id": 419, "name": "provider", "kind": 1024, "kindString": "Property", @@ -16206,7 +17381,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 209, + "line": 210, "character": 2 } ], @@ -16220,25 +17395,27 @@ { "title": "Properties", "kind": 1024, - "children": [414] + "children": [ + 419 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 209, "character": 17 } ], "indexSignature": { - "id": 415, + "id": 420, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 416, + "id": 421, "name": "key", "kind": 32768, "flags": {}, @@ -16255,14 +17432,14 @@ } }, { - "id": 443, + "id": 448, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 447, + "id": 453, "name": "data", "kind": 1024, "kindString": "Property", @@ -16276,7 +17453,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 264, + "line": 272, "character": 2 } ], @@ -16286,7 +17463,7 @@ } }, { - "id": 444, + "id": 449, "name": "email", "kind": 1024, "kindString": "Property", @@ -16299,7 +17476,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 247, "character": 2 } ], @@ -16309,7 +17486,31 @@ } }, { - "id": 446, + "id": 452, + "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": 264, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, "name": "password", "kind": 1024, "kindString": "Property", @@ -16322,7 +17523,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 257, "character": 2 } ], @@ -16332,7 +17533,7 @@ } }, { - "id": 445, + "id": 450, "name": "phone", "kind": 1024, "kindString": "Property", @@ -16345,7 +17546,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 251, + "line": 252, "character": 2 } ], @@ -16359,119 +17560,38 @@ { "title": "Properties", "kind": 1024, - "children": [447, 444, 446, 445] + "children": [ + 453, + 449, + 452, + 451, + 450 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 242, + "line": 243, "character": 17 } ] }, { - "id": 395, + "id": 400, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 403, + "id": 408, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 176, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 396, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 170, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 398, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 172, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 399, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 400, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 401, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 404, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -16485,15 +17605,15 @@ } }, { - "id": 402, - "name": "provider", + "id": 401, + "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 175, + "line": 171, "character": 2 } ], @@ -16503,8 +17623,57 @@ } }, { - "id": 405, - "name": "updated_at", + "id": 403, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 173, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 404, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 405, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 406, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 409, + "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", "flags": { @@ -16523,7 +17692,45 @@ } }, { - "id": 397, + "id": 407, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 176, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 410, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 179, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 402, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -16531,7 +17738,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 171, + "line": 172, "character": 2 } ], @@ -16545,19 +17752,27 @@ { "title": "Properties", "kind": 1024, - "children": [403, 396, 398, 404, 402, 405, 397] + "children": [ + 408, + 401, + 403, + 409, + 407, + 410, + 402 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 169, + "line": 170, "character": 17 } ] }, { - "id": 417, + "id": 422, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -16565,19 +17780,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 214, "character": 17 } ], "indexSignature": { - "id": 418, + "id": 423, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 419, + "id": 424, "name": "key", "kind": 32768, "flags": {}, @@ -16594,14 +17809,14 @@ } }, { - "id": 545, + "id": 552, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 546, + "id": 553, "name": "email", "kind": 1024, "kindString": "Property", @@ -16612,7 +17827,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 492, + "line": 500, "character": 2 } ], @@ -16622,7 +17837,7 @@ } }, { - "id": 549, + "id": 556, "name": "options", "kind": 1024, "kindString": "Property", @@ -16632,21 +17847,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 497, + "line": 505, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 550, + "id": 557, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 559, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16659,7 +17874,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 501, + "line": 509, "character": 4 } ], @@ -16669,7 +17884,7 @@ } }, { - "id": 551, + "id": 558, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -16682,7 +17897,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 499, + "line": 507, "character": 4 } ], @@ -16696,14 +17911,17 @@ { "title": "Properties", "kind": 1024, - "children": [552, 551] + "children": [ + 559, + 558 + ] } ] } } }, { - "id": 547, + "id": 554, "name": "token", "kind": 1024, "kindString": "Property", @@ -16714,7 +17932,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 494, + "line": 502, "character": 2 } ], @@ -16724,7 +17942,7 @@ } }, { - "id": 548, + "id": 555, "name": "type", "kind": 1024, "kindString": "Property", @@ -16735,16 +17953,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 496, + "line": 504, "character": 2 } ], "type": { "type": "reference", - "id": 554, + "id": 561, "name": "EmailOtpType", "dereferenced": { - "id": 554, + "id": 561, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -16752,7 +17970,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 514, "character": 12 } ], @@ -16793,26 +18011,31 @@ { "title": "Properties", "kind": 1024, - "children": [546, 549, 547, 548] + "children": [ + 553, + 556, + 554, + 555 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 490, + "line": 498, "character": 17 } ] }, { - "id": 537, + "id": 544, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 541, + "id": 548, "name": "options", "kind": 1024, "kindString": "Property", @@ -16822,21 +18045,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 478, + "line": 486, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 542, + "id": 549, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 551, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16855,7 +18078,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 495, "character": 4 } ], @@ -16865,7 +18088,7 @@ } }, { - "id": 543, + "id": 550, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -16878,7 +18101,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 480, + "line": 488, "character": 4 } ], @@ -16892,14 +18115,17 @@ { "title": "Properties", "kind": 1024, - "children": [544, 543] + "children": [ + 551, + 550 + ] } ] } } }, { - "id": 538, + "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", @@ -16910,7 +18136,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 473, + "line": 481, "character": 2 } ], @@ -16920,7 +18146,7 @@ } }, { - "id": 539, + "id": 546, "name": "token", "kind": 1024, "kindString": "Property", @@ -16931,7 +18157,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 475, + "line": 483, "character": 2 } ], @@ -16941,7 +18167,7 @@ } }, { - "id": 540, + "id": 547, "name": "type", "kind": 1024, "kindString": "Property", @@ -16952,16 +18178,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 477, + "line": 485, "character": 2 } ], "type": { "type": "reference", - "id": 553, + "id": 560, "name": "MobileOtpType", "dereferenced": { - "id": 553, + "id": 560, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -16969,7 +18195,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 513, "character": 12 } ], @@ -16994,19 +18220,24 @@ { "title": "Properties", "kind": 1024, - "children": [541, 538, 539, 540] + "children": [ + 548, + 545, + 546, + 547 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 479, "character": 17 } ] }, { - "id": 322, + "id": 327, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -17014,7 +18245,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 25, + "line": 26, "character": 12 } ], @@ -17046,7 +18277,7 @@ "value": "USER_UPDATED" }, { - "id": 321, + "id": 326, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -17054,7 +18285,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, + "line": 24, "character": 12 } ], @@ -17067,7 +18298,7 @@ } }, { - "id": 321, + "id": 326, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -17075,7 +18306,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, + "line": 24, "character": 12 } ], @@ -17085,7 +18316,7 @@ } }, { - "id": 515, + "id": 522, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -17093,7 +18324,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 439, + "line": 447, "character": 12 } ], @@ -17112,7 +18343,7 @@ } }, { - "id": 733, + "id": 753, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -17128,21 +18359,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "id", "kind": 1024, "kindString": "Property", @@ -17153,7 +18384,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 870, + "line": 896, "character": 2 } ], @@ -17163,7 +18394,7 @@ } }, { - "id": 736, + "id": 756, "name": "userId", "kind": 1024, "kindString": "Property", @@ -17174,7 +18405,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 873, + "line": 899, "character": 2 } ], @@ -17188,13 +18419,16 @@ { "title": "Properties", "kind": 1024, - "children": [735, 736] + "children": [ + 755, + 756 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 868, + "line": 894, "character": 45 } ] @@ -17202,7 +18436,7 @@ } }, { - "id": 724, + "id": 744, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", @@ -17218,7 +18452,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 855, + "line": 881, "character": 12 } ], @@ -17228,14 +18462,14 @@ { "type": "reflection", "declaration": { - "id": 725, + "id": 745, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 726, + "id": 746, "name": "data", "kind": 1024, "kindString": "Property", @@ -17243,21 +18477,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 857, + "line": 883, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 727, + "id": 747, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 728, + "id": 748, "name": "id", "kind": 1024, "kindString": "Property", @@ -17268,7 +18502,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 859, + "line": 885, "character": 8 } ], @@ -17282,13 +18516,15 @@ { "title": "Properties", "kind": 1024, - "children": [728] + "children": [ + 748 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 857, + "line": 883, "character": 12 } ] @@ -17296,7 +18532,7 @@ } }, { - "id": 729, + "id": 749, "name": "error", "kind": 1024, "kindString": "Property", @@ -17304,7 +18540,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 861, + "line": 887, "character": 6 } ], @@ -17318,13 +18554,16 @@ { "title": "Properties", "kind": 1024, - "children": [726, 729] + "children": [ + 746, + 749 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 856, + "line": 882, "character": 4 } ] @@ -17333,14 +18572,14 @@ { "type": "reflection", "declaration": { - "id": 730, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 751, "name": "data", "kind": 1024, "kindString": "Property", @@ -17348,7 +18587,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 863, + "line": 889, "character": 6 } ], @@ -17358,7 +18597,7 @@ } }, { - "id": 732, + "id": 752, "name": "error", "kind": 1024, "kindString": "Property", @@ -17366,13 +18605,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 863, + "line": 889, "character": 18 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -17381,13 +18620,16 @@ { "title": "Properties", "kind": 1024, - "children": [731, 732] + "children": [ + 751, + 752 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 863, + "line": 889, "character": 4 } ] @@ -17397,7 +18639,7 @@ } }, { - "id": 746, + "id": 766, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -17413,21 +18655,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 747, + "id": 767, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 768, "name": "userId", "kind": 1024, "kindString": "Property", @@ -17438,7 +18680,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 920, "character": 2 } ], @@ -17452,13 +18694,15 @@ { "title": "Properties", "kind": 1024, - "children": [748] + "children": [ + 768 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 918, "character": 44 } ] @@ -17466,7 +18710,7 @@ } }, { - "id": 737, + "id": 757, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -17482,7 +18726,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 879, + "line": 905, "character": 12 } ], @@ -17492,14 +18736,14 @@ { "type": "reflection", "declaration": { - "id": 738, + "id": 758, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 739, + "id": 759, "name": "data", "kind": 1024, "kindString": "Property", @@ -17507,21 +18751,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 881, + "line": 907, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 740, + "id": 760, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 741, + "id": 761, "name": "factors", "kind": 1024, "kindString": "Property", @@ -17532,7 +18776,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 883, + "line": 909, "character": 8 } ], @@ -17540,7 +18784,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, + "id": 411, "name": "Factor" } } @@ -17550,13 +18794,15 @@ { "title": "Properties", "kind": 1024, - "children": [741] + "children": [ + 761 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 881, + "line": 907, "character": 12 } ] @@ -17564,7 +18810,7 @@ } }, { - "id": 742, + "id": 762, "name": "error", "kind": 1024, "kindString": "Property", @@ -17572,7 +18818,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 885, + "line": 911, "character": 6 } ], @@ -17586,13 +18832,16 @@ { "title": "Properties", "kind": 1024, - "children": [739, 742] + "children": [ + 759, + 762 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 880, + "line": 906, "character": 4 } ] @@ -17601,14 +18850,14 @@ { "type": "reflection", "declaration": { - "id": 743, + "id": 763, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 764, "name": "data", "kind": 1024, "kindString": "Property", @@ -17616,7 +18865,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 887, + "line": 913, "character": 6 } ], @@ -17626,7 +18875,7 @@ } }, { - "id": 745, + "id": 765, "name": "error", "kind": 1024, "kindString": "Property", @@ -17634,13 +18883,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 887, + "line": 913, "character": 18 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -17649,13 +18898,16 @@ { "title": "Properties", "kind": 1024, - "children": [744, 745] + "children": [ + 764, + 765 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 887, + "line": 913, "character": 4 } ] @@ -17665,7 +18917,7 @@ } }, { - "id": 672, + "id": 692, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -17673,7 +18925,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 732, + "line": 758, "character": 12 } ], @@ -17683,14 +18935,14 @@ { "type": "reflection", "declaration": { - "id": 673, + "id": 693, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 674, + "id": 694, "name": "data", "kind": 1024, "kindString": "Property", @@ -17698,21 +18950,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 734, + "line": 760, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 675, + "id": 695, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 677, + "id": 697, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -17723,7 +18975,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 739, + "line": 765, "character": 8 } ], @@ -17733,7 +18985,7 @@ } }, { - "id": 676, + "id": 696, "name": "id", "kind": 1024, "kindString": "Property", @@ -17744,7 +18996,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 736, + "line": 762, "character": 8 } ], @@ -17758,13 +19010,16 @@ { "title": "Properties", "kind": 1024, - "children": [677, 676] + "children": [ + 697, + 696 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 734, + "line": 760, "character": 12 } ] @@ -17772,7 +19027,335 @@ } }, { - "id": 678, + "id": 698, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 767, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 694, + 698 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 759, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 699, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 700, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 701, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 700, + 701 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 769, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 668, + "name": "AuthMFAEnrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 715, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 669, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 670, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 717, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 671, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 672, + "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": 719, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 674, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 725, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 675, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 676, + "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": 729, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 677, + "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": 734, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 678, + "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": 738, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 676, + 677, + 678 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 725, + "character": 14 + } + ] + } + } + }, + { + "id": 673, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor. Only `totp` supported for now." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 722, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 672, + 674, + 673 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 717, + "character": 12 + } + ] + } + } + }, + { + "id": 679, "name": "error", "kind": 1024, "kindString": "Property", @@ -17794,13 +19377,16 @@ { "title": "Properties", "kind": 1024, - "children": [674, 678] + "children": [ + 670, + 679 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 716, "character": 4 } ] @@ -17809,14 +19395,14 @@ { "type": "reflection", "declaration": { - "id": 679, + "id": 680, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 680, + "id": 681, "name": "data", "kind": 1024, "kindString": "Property", @@ -17824,7 +19410,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 743, + "line": 744, "character": 6 } ], @@ -17834,7 +19420,7 @@ } }, { - "id": 681, + "id": 682, "name": "error", "kind": 1024, "kindString": "Property", @@ -17842,13 +19428,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 743, - "character": 18 + "line": 745, + "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -17857,7 +19443,10 @@ { "title": "Properties", "kind": 1024, - "children": [680, 681] + "children": [ + 681, + 682 + ] } ], "sources": [ @@ -17873,321 +19462,7 @@ } }, { - "id": 648, - "name": "AuthMFAEnrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 689, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 650, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 691, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 651, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 652, - "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": 693, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "TOTP enrollment information." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 699, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 655, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 656, - "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": 703, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 657, - "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": 708, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "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": 712, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [656, 657, 658] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 699, - "character": 14 - } - ] - } - } - }, - { - "id": 653, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of MFA factor. Only `totp` supported for now." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 696, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [652, 654, 653] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 691, - "character": 12 - } - ] - } - } - }, - { - "id": 659, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 715, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [650, 659] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 690, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 660, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 661, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 718, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 662, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 719, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [661, 662] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 717, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 693, + "id": 713, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", @@ -18195,7 +19470,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 760, + "line": 786, "character": 12 } ], @@ -18205,14 +19480,14 @@ { "type": "reflection", "declaration": { - "id": 694, + "id": 714, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 695, + "id": 715, "name": "data", "kind": 1024, "kindString": "Property", @@ -18220,21 +19495,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 762, + "line": 788, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 696, + "id": 716, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 699, + "id": 719, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", @@ -18245,7 +19520,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 779, + "line": 805, "character": 8 } ], @@ -18253,13 +19528,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 392, + "id": 397, "name": "AMREntry" } } }, { - "id": 697, + "id": 717, "name": "currentLevel", "kind": 1024, "kindString": "Property", @@ -18270,7 +19545,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 764, + "line": 790, "character": 8 } ], @@ -18279,7 +19554,7 @@ "types": [ { "type": "reference", - "id": 692, + "id": 712, "name": "AuthenticatorAssuranceLevels" }, { @@ -18290,7 +19565,7 @@ } }, { - "id": 698, + "id": 718, "name": "nextLevel", "kind": 1024, "kindString": "Property", @@ -18307,7 +19582,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 772, + "line": 798, "character": 8 } ], @@ -18316,7 +19591,7 @@ "types": [ { "type": "reference", - "id": 692, + "id": 712, "name": "AuthenticatorAssuranceLevels" }, { @@ -18331,13 +19606,17 @@ { "title": "Properties", "kind": 1024, - "children": [699, 697, 698] + "children": [ + 719, + 717, + 718 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 762, + "line": 788, "character": 12 } ] @@ -18345,7 +19624,7 @@ } }, { - "id": 700, + "id": 720, "name": "error", "kind": 1024, "kindString": "Property", @@ -18353,7 +19632,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 781, + "line": 807, "character": 6 } ], @@ -18367,13 +19646,16 @@ { "title": "Properties", "kind": 1024, - "children": [695, 700] + "children": [ + 715, + 720 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 761, + "line": 787, "character": 4 } ] @@ -18382,14 +19664,14 @@ { "type": "reflection", "declaration": { - "id": 701, + "id": 721, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 702, + "id": 722, "name": "data", "kind": 1024, "kindString": "Property", @@ -18397,7 +19679,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 783, + "line": 809, "character": 6 } ], @@ -18407,7 +19689,7 @@ } }, { - "id": 703, + "id": 723, "name": "error", "kind": 1024, "kindString": "Property", @@ -18415,13 +19697,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 783, + "line": 809, "character": 18 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -18430,13 +19712,16 @@ { "title": "Properties", "kind": 1024, - "children": [702, 703] + "children": [ + 722, + 723 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 783, + "line": 809, "character": 4 } ] @@ -18446,7 +19731,7 @@ } }, { - "id": 682, + "id": 702, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -18454,7 +19739,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 745, + "line": 771, "character": 12 } ], @@ -18464,14 +19749,14 @@ { "type": "reflection", "declaration": { - "id": 683, + "id": 703, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 684, + "id": 704, "name": "data", "kind": 1024, "kindString": "Property", @@ -18479,21 +19764,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 747, + "line": 773, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 685, + "id": 705, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 686, + "id": 706, "name": "all", "kind": 1024, "kindString": "Property", @@ -18504,7 +19789,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 749, + "line": 775, "character": 8 } ], @@ -18512,13 +19797,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, + "id": 411, "name": "Factor" } } }, { - "id": 687, + "id": 707, "name": "totp", "kind": 1024, "kindString": "Property", @@ -18529,7 +19814,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 752, + "line": 778, "character": 8 } ], @@ -18537,7 +19822,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 406, + "id": 411, "name": "Factor" } } @@ -18547,13 +19832,211 @@ { "title": "Properties", "kind": 1024, - "children": [686, 687] + "children": [ + 706, + 707 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 747, + "line": 773, + "character": 12 + } + ] + } + } + }, + { + "id": 708, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 780, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 704, + 708 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 772, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 709, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 710, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 711, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 804, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 710, + 711 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 782, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 683, + "name": "AuthMFAUnenrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 748, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 684, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 685, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 750, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 686, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 687, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 752, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 687 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 750, "character": 12 } ] @@ -18583,13 +20066,16 @@ { "title": "Properties", "kind": 1024, - "children": [684, 688] + "children": [ + 685, + 688 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 746, + "line": 749, "character": 4 } ] @@ -18637,7 +20123,7 @@ ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -18646,7 +20132,10 @@ { "title": "Properties", "kind": 1024, - "children": [690, 691] + "children": [ + 690, + 691 + ] } ], "sources": [ @@ -18662,194 +20151,7 @@ } }, { - "id": 663, - "name": "AuthMFAUnenrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 722, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 664, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 665, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 724, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 666, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 667, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 726, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [667] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 724, - "character": 12 - } - ] - } - } - }, - { - "id": 668, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 728, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [665, 668] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 723, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 669, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 670, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 671, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [670, 671] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 635, + "id": 655, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -18857,7 +20159,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 664, + "line": 690, "character": 12 } ], @@ -18867,14 +20169,14 @@ { "type": "reflection", "declaration": { - "id": 636, + "id": 656, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 637, + "id": 657, "name": "data", "kind": 1024, "kindString": "Property", @@ -18882,21 +20184,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 692, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 638, + "id": 658, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 639, + "id": 659, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -18907,7 +20209,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 668, + "line": 694, "character": 8 } ], @@ -18917,7 +20219,7 @@ } }, { - "id": 641, + "id": 661, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -18928,7 +20230,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 674, + "line": 700, "character": 8 } ], @@ -18938,7 +20240,7 @@ } }, { - "id": 642, + "id": 662, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -18949,7 +20251,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 677, + "line": 703, "character": 8 } ], @@ -18959,7 +20261,7 @@ } }, { - "id": 640, + "id": 660, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -18970,7 +20272,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 697, "character": 8 } ], @@ -18980,7 +20282,7 @@ } }, { - "id": 643, + "id": 663, "name": "user", "kind": 1024, "kindString": "Property", @@ -18991,13 +20293,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 680, + "line": 706, "character": 8 } ], "type": { "type": "reference", - "id": 420, + "id": 425, "name": "User" } } @@ -19006,13 +20308,19 @@ { "title": "Properties", "kind": 1024, - "children": [639, 641, 642, 640, 643] + "children": [ + 659, + 661, + 662, + 660, + 663 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 692, "character": 12 } ] @@ -19020,7 +20328,7 @@ } }, { - "id": 644, + "id": 664, "name": "error", "kind": 1024, "kindString": "Property", @@ -19028,7 +20336,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 708, "character": 6 } ], @@ -19042,13 +20350,16 @@ { "title": "Properties", "kind": 1024, - "children": [637, 644] + "children": [ + 657, + 664 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 665, + "line": 691, "character": 4 } ] @@ -19057,14 +20368,14 @@ { "type": "reflection", "declaration": { - "id": 645, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 646, + "id": 666, "name": "data", "kind": 1024, "kindString": "Property", @@ -19072,7 +20383,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 685, + "line": 711, "character": 6 } ], @@ -19082,7 +20393,7 @@ } }, { - "id": 647, + "id": 667, "name": "error", "kind": 1024, "kindString": "Property", @@ -19090,13 +20401,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 686, + "line": 712, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -19105,13 +20416,16 @@ { "title": "Properties", "kind": 1024, - "children": [646, 647] + "children": [ + 666, + 667 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 684, + "line": 710, "character": 4 } ] @@ -19121,7 +20435,7 @@ } }, { - "id": 337, + "id": 342, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -19129,7 +20443,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 56, "character": 12 } ], @@ -19139,14 +20453,14 @@ { "type": "reflection", "declaration": { - "id": 338, + "id": 343, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 339, + "id": 344, "name": "data", "kind": 1024, "kindString": "Property", @@ -19154,25 +20468,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 57, + "line": 58, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 340, + "id": 345, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 347, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 60, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 346, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -19185,35 +20527,7 @@ "types": [ { "type": "reference", - "id": 383, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 341, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 420, + "id": 425, "name": "User" }, { @@ -19228,13 +20542,16 @@ { "title": "Properties", "kind": 1024, - "children": [342, 341] + "children": [ + 347, + 346 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 57, + "line": 58, "character": 12 } ] @@ -19242,7 +20559,7 @@ } }, { - "id": 343, + "id": 348, "name": "error", "kind": 1024, "kindString": "Property", @@ -19250,7 +20567,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 61, + "line": 62, "character": 6 } ], @@ -19264,13 +20581,16 @@ { "title": "Properties", "kind": 1024, - "children": [339, 343] + "children": [ + 344, + 348 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 4 } ] @@ -19279,14 +20599,14 @@ { "type": "reflection", "declaration": { - "id": 344, + "id": 349, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 345, + "id": 350, "name": "data", "kind": 1024, "kindString": "Property", @@ -19294,25 +20614,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 346, + "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 348, + "id": 353, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 352, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -19324,37 +20662,22 @@ "type": "literal", "value": null } - }, - { - "id": 347, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 65, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [348, 347] + "children": [ + 353, + 352 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 12 } ] @@ -19362,7 +20685,7 @@ } }, { - "id": 349, + "id": 354, "name": "error", "kind": 1024, "kindString": "Property", @@ -19370,13 +20693,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 68, + "line": 69, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -19385,13 +20708,16 @@ { "title": "Properties", "kind": 1024, - "children": [345, 349] + "children": [ + 350, + 354 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, + "line": 64, "character": 4 } ] @@ -19401,7 +20727,7 @@ } }, { - "id": 692, + "id": 712, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -19409,7 +20735,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 758, + "line": 784, "character": 12 } ], @@ -19428,7 +20754,7 @@ } }, { - "id": 760, + "id": 780, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -19436,7 +20762,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 933, + "line": 959, "character": 12 } ], @@ -19446,14 +20772,14 @@ { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "error", "kind": 1024, "kindString": "Property", @@ -19461,7 +20787,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 936, + "line": 962, "character": 6 } ], @@ -19471,7 +20797,7 @@ } }, { - "id": 762, + "id": 782, "name": "session", "kind": 1024, "kindString": "Property", @@ -19479,13 +20805,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 935, + "line": 961, "character": 6 } ], "type": { "type": "reference", - "id": 383, + "id": 388, "name": "Session" } } @@ -19494,13 +20820,16 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [ + 783, + 782 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 934, + "line": 960, "character": 4 } ] @@ -19509,14 +20838,14 @@ { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 766, + "id": 786, "name": "error", "kind": 1024, "kindString": "Property", @@ -19524,18 +20853,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 940, + "line": 966, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } }, { - "id": 765, + "id": 785, "name": "session", "kind": 1024, "kindString": "Property", @@ -19543,7 +20872,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 939, + "line": 965, "character": 6 } ], @@ -19557,13 +20886,16 @@ { "title": "Properties", "kind": 1024, - "children": [766, 765] + "children": [ + 786, + 785 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 938, + "line": 964, "character": 4 } ] @@ -19573,7 +20905,7 @@ } }, { - "id": 554, + "id": 561, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -19581,7 +20913,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 514, "character": 12 } ], @@ -19616,7 +20948,7 @@ } }, { - "id": 584, + "id": 604, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -19624,21 +20956,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 607, "name": "email", "kind": 1024, "kindString": "Property", @@ -19649,7 +20981,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 556, + "line": 582, "character": 2 } ], @@ -19659,7 +20991,7 @@ } }, { - "id": 588, + "id": 608, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -19670,7 +21002,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 560, + "line": 586, "character": 2 } ], @@ -19680,7 +21012,7 @@ } }, { - "id": 589, + "id": 609, "name": "options", "kind": 1024, "kindString": "Property", @@ -19690,7 +21022,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 587, "character": 2 } ], @@ -19699,7 +21031,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -19713,7 +21045,7 @@ } }, { - "id": 586, + "id": 606, "name": "type", "kind": 1024, "kindString": "Property", @@ -19721,7 +21053,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 554, + "line": 580, "character": 2 } ], @@ -19744,13 +21076,18 @@ { "title": "Properties", "kind": 1024, - "children": [587, 588, 589, 586] + "children": [ + 607, + 608, + 609, + 606 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 44 } ] @@ -19758,7 +21095,7 @@ } }, { - "id": 574, + "id": 594, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -19766,21 +21103,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 597, "name": "email", "kind": 1024, "kindString": "Property", @@ -19791,7 +21128,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 542, + "line": 568, "character": 2 } ], @@ -19801,7 +21138,7 @@ } }, { - "id": 578, + "id": 598, "name": "options", "kind": 1024, "kindString": "Property", @@ -19811,7 +21148,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 543, + "line": 569, "character": 2 } ], @@ -19820,7 +21157,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -19843,7 +21180,7 @@ } }, { - "id": 576, + "id": 596, "name": "type", "kind": 1024, "kindString": "Property", @@ -19851,7 +21188,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 540, + "line": 566, "character": 2 } ], @@ -19874,13 +21211,17 @@ { "title": "Properties", "kind": 1024, - "children": [577, 578, 576] + "children": [ + 597, + 598, + 596 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 46 } ] @@ -19888,7 +21229,7 @@ } }, { - "id": 593, + "id": 613, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -19896,7 +21237,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 601, "character": 12 } ], @@ -19904,7 +21245,7 @@ "type": "union", "types": [ { - "id": 568, + "id": 588, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -19912,21 +21253,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 589, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 571, + "id": 591, "name": "email", "kind": 1024, "kindString": "Property", @@ -19934,7 +21275,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 534, + "line": 560, "character": 2 } ], @@ -19944,7 +21285,7 @@ } }, { - "id": 573, + "id": 593, "name": "options", "kind": 1024, "kindString": "Property", @@ -19954,7 +21295,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 536, + "line": 562, "character": 2 } ], @@ -19963,7 +21304,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -19986,7 +21327,7 @@ } }, { - "id": 572, + "id": 592, "name": "password", "kind": 1024, "kindString": "Property", @@ -19994,7 +21335,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 535, + "line": 561, "character": 2 } ], @@ -20004,7 +21345,7 @@ } }, { - "id": 570, + "id": 590, "name": "type", "kind": 1024, "kindString": "Property", @@ -20012,7 +21353,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 533, + "line": 559, "character": 2 } ], @@ -20026,13 +21367,18 @@ { "title": "Properties", "kind": 1024, - "children": [571, 573, 572, 570] + "children": [ + 591, + 593, + 592, + 590 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 39 } ] @@ -20040,7 +21386,7 @@ } }, { - "id": 574, + "id": 594, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -20048,21 +21394,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 597, "name": "email", "kind": 1024, "kindString": "Property", @@ -20073,7 +21419,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 542, + "line": 568, "character": 2 } ], @@ -20083,7 +21429,7 @@ } }, { - "id": 578, + "id": 598, "name": "options", "kind": 1024, "kindString": "Property", @@ -20093,7 +21439,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 543, + "line": 569, "character": 2 } ], @@ -20102,7 +21448,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -20125,7 +21471,7 @@ } }, { - "id": 576, + "id": 596, "name": "type", "kind": 1024, "kindString": "Property", @@ -20133,7 +21479,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 540, + "line": 566, "character": 2 } ], @@ -20156,13 +21502,17 @@ { "title": "Properties", "kind": 1024, - "children": [577, 578, 576] + "children": [ + 597, + 598, + 596 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 539, + "line": 565, "character": 46 } ] @@ -20170,7 +21520,7 @@ } }, { - "id": 579, + "id": 599, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -20178,21 +21528,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 602, "name": "email", "kind": 1024, "kindString": "Property", @@ -20203,7 +21553,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 575, "character": 2 } ], @@ -20213,7 +21563,7 @@ } }, { - "id": 583, + "id": 603, "name": "options", "kind": 1024, "kindString": "Property", @@ -20223,7 +21573,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 550, + "line": 576, "character": 2 } ], @@ -20232,7 +21582,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -20246,7 +21596,7 @@ } }, { - "id": 581, + "id": 601, "name": "type", "kind": 1024, "kindString": "Property", @@ -20254,7 +21604,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 547, + "line": 573, "character": 2 } ], @@ -20268,13 +21618,17 @@ { "title": "Properties", "kind": 1024, - "children": [582, 583, 581] + "children": [ + 602, + 603, + 601 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 41 } ] @@ -20282,7 +21636,7 @@ } }, { - "id": 584, + "id": 604, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -20290,21 +21644,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 607, "name": "email", "kind": 1024, "kindString": "Property", @@ -20315,7 +21669,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 556, + "line": 582, "character": 2 } ], @@ -20325,7 +21679,7 @@ } }, { - "id": 588, + "id": 608, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -20336,7 +21690,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 560, + "line": 586, "character": 2 } ], @@ -20346,7 +21700,7 @@ } }, { - "id": 589, + "id": 609, "name": "options", "kind": 1024, "kindString": "Property", @@ -20356,7 +21710,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 587, "character": 2 } ], @@ -20365,7 +21719,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -20379,7 +21733,7 @@ } }, { - "id": 586, + "id": 606, "name": "type", "kind": 1024, "kindString": "Property", @@ -20387,7 +21741,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 554, + "line": 580, "character": 2 } ], @@ -20410,13 +21764,18 @@ { "title": "Properties", "kind": 1024, - "children": [587, 588, 589, 586] + "children": [ + 607, + 608, + 609, + 606 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 553, + "line": 579, "character": 44 } ] @@ -20427,7 +21786,7 @@ } }, { - "id": 607, + "id": 627, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", @@ -20438,21 +21797,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 598, + "line": 624, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 608, + "id": 628, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, + "id": 629, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -20463,7 +21822,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 603, + "line": 629, "character": 2 } ], @@ -20473,7 +21832,7 @@ } }, { - "id": 610, + "id": 630, "name": "email_otp", "kind": 1024, "kindString": "Property", @@ -20484,7 +21843,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 608, + "line": 634, "character": 2 } ], @@ -20494,7 +21853,7 @@ } }, { - "id": 611, + "id": 631, "name": "hashed_token", "kind": 1024, "kindString": "Property", @@ -20505,7 +21864,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 612, + "line": 638, "character": 2 } ], @@ -20515,7 +21874,7 @@ } }, { - "id": 612, + "id": 632, "name": "redirect_to", "kind": 1024, "kindString": "Property", @@ -20526,7 +21885,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 614, + "line": 640, "character": 2 } ], @@ -20536,7 +21895,7 @@ } }, { - "id": 613, + "id": 633, "name": "verification_type", "kind": 1024, "kindString": "Property", @@ -20547,16 +21906,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 616, + "line": 642, "character": 2 } ], "type": { "type": "reference", - "id": 614, + "id": 634, "name": "GenerateLinkType", "dereferenced": { - "id": 614, + "id": 634, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -20564,7 +21923,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 619, + "line": 645, "character": 12 } ], @@ -20605,13 +21964,19 @@ { "title": "Properties", "kind": 1024, - "children": [609, 610, 611, 612, 613] + "children": [ + 629, + 630, + 631, + 632, + 633 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 598, + "line": 624, "character": 37 } ] @@ -20619,7 +21984,7 @@ } }, { - "id": 594, + "id": 614, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -20627,7 +21992,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 607, "character": 12 } ], @@ -20637,14 +22002,14 @@ { "type": "reflection", "declaration": { - "id": 595, + "id": 615, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 596, + "id": 616, "name": "data", "kind": 1024, "kindString": "Property", @@ -20652,21 +22017,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 609, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 597, + "id": 617, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 598, + "id": 618, "name": "properties", "kind": 1024, "kindString": "Property", @@ -20674,18 +22039,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 584, + "line": 610, "character": 8 } ], "type": { "type": "reference", - "id": 607, + "id": 627, "name": "GenerateLinkProperties" } }, { - "id": 599, + "id": 619, "name": "user", "kind": 1024, "kindString": "Property", @@ -20693,13 +22058,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 585, + "line": 611, "character": 8 } ], "type": { "type": "reference", - "id": 420, + "id": 425, "name": "User" } } @@ -20708,13 +22073,16 @@ { "title": "Properties", "kind": 1024, - "children": [598, 599] + "children": [ + 618, + 619 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 609, "character": 12 } ] @@ -20722,7 +22090,7 @@ } }, { - "id": 600, + "id": 620, "name": "error", "kind": 1024, "kindString": "Property", @@ -20730,7 +22098,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 587, + "line": 613, "character": 6 } ], @@ -20744,13 +22112,16 @@ { "title": "Properties", "kind": 1024, - "children": [596, 600] + "children": [ + 616, + 620 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 582, + "line": 608, "character": 4 } ] @@ -20759,14 +22130,14 @@ { "type": "reflection", "declaration": { - "id": 601, + "id": 621, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 602, + "id": 622, "name": "data", "kind": 1024, "kindString": "Property", @@ -20774,21 +22145,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 616, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 603, + "id": 623, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 604, + "id": 624, "name": "properties", "kind": 1024, "kindString": "Property", @@ -20796,7 +22167,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 591, + "line": 617, "character": 8 } ], @@ -20806,7 +22177,7 @@ } }, { - "id": 605, + "id": 625, "name": "user", "kind": 1024, "kindString": "Property", @@ -20814,7 +22185,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 592, + "line": 618, "character": 8 } ], @@ -20828,13 +22199,16 @@ { "title": "Properties", "kind": 1024, - "children": [604, 605] + "children": [ + 624, + 625 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 616, "character": 12 } ] @@ -20842,7 +22216,7 @@ } }, { - "id": 606, + "id": 626, "name": "error", "kind": 1024, "kindString": "Property", @@ -20850,13 +22224,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 594, + "line": 620, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -20865,13 +22239,16 @@ { "title": "Properties", "kind": 1024, - "children": [602, 606] + "children": [ + 622, + 626 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 589, + "line": 615, "character": 4 } ] @@ -20881,7 +22258,7 @@ } }, { - "id": 614, + "id": 634, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -20889,7 +22266,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 619, + "line": 645, "character": 12 } ], @@ -20924,7 +22301,7 @@ } }, { - "id": 579, + "id": 599, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -20932,21 +22309,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 602, "name": "email", "kind": 1024, "kindString": "Property", @@ -20957,7 +22334,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 575, "character": 2 } ], @@ -20967,7 +22344,7 @@ } }, { - "id": 583, + "id": 603, "name": "options", "kind": 1024, "kindString": "Property", @@ -20977,7 +22354,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 550, + "line": 576, "character": 2 } ], @@ -20986,7 +22363,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -21000,7 +22377,7 @@ } }, { - "id": 581, + "id": 601, "name": "type", "kind": 1024, "kindString": "Property", @@ -21008,7 +22385,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 547, + "line": 573, "character": 2 } ], @@ -21022,13 +22399,17 @@ { "title": "Properties", "kind": 1024, - "children": [582, 583, 581] + "children": [ + 602, + 603, + 601 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 572, "character": 41 } ] @@ -21036,7 +22417,7 @@ } }, { - "id": 568, + "id": 588, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -21044,21 +22425,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 589, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 571, + "id": 591, "name": "email", "kind": 1024, "kindString": "Property", @@ -21066,7 +22447,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 534, + "line": 560, "character": 2 } ], @@ -21076,7 +22457,7 @@ } }, { - "id": 573, + "id": 593, "name": "options", "kind": 1024, "kindString": "Property", @@ -21086,7 +22467,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 536, + "line": 562, "character": 2 } ], @@ -21095,7 +22476,7 @@ "typeArguments": [ { "type": "reference", - "id": 590, + "id": 610, "name": "GenerateLinkOptions" }, { @@ -21118,7 +22499,7 @@ } }, { - "id": 572, + "id": 592, "name": "password", "kind": 1024, "kindString": "Property", @@ -21126,7 +22507,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 535, + "line": 561, "character": 2 } ], @@ -21136,7 +22517,7 @@ } }, { - "id": 570, + "id": 590, "name": "type", "kind": 1024, "kindString": "Property", @@ -21144,7 +22525,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 533, + "line": 559, "character": 2 } ], @@ -21158,13 +22539,18 @@ { "title": "Properties", "kind": 1024, - "children": [571, 573, 572, 570] + "children": [ + 591, + 593, + 592, + 590 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 532, + "line": 558, "character": 39 } ] @@ -21172,7 +22558,7 @@ } }, { - "id": 323, + "id": 328, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -21180,21 +22566,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 35, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 332, + "id": 337, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -21204,7 +22590,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 44, + "line": 45, "character": 2 } ], @@ -21214,7 +22600,7 @@ } }, { - "id": 331, + "id": 336, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -21224,7 +22610,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 42, + "line": 43, "character": 2 } ], @@ -21234,7 +22620,7 @@ } }, { - "id": 335, + "id": 340, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -21244,7 +22630,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 50, + "line": 51, "character": 2 } ], @@ -21254,7 +22640,7 @@ } }, { - "id": 336, + "id": 341, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -21264,16 +22650,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 52, + "line": 53, "character": 2 } ], "type": { "type": "reference", - "id": 515, + "id": 522, "name": "AuthFlowType", "dereferenced": { - "id": 515, + "id": 522, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -21281,7 +22667,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 439, + "line": 447, "character": 12 } ], @@ -21302,7 +22688,7 @@ } }, { - "id": 326, + "id": 331, "name": "headers", "kind": 1024, "kindString": "Property", @@ -21312,14 +22698,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 327, + "id": 332, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -21327,19 +22713,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 12 } ], "indexSignature": { - "id": 328, + "id": 333, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 329, + "id": 334, "name": "key", "kind": 32768, "flags": {}, @@ -21358,7 +22744,7 @@ } }, { - "id": 333, + "id": 338, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -21368,7 +22754,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 47, "character": 2 } ], @@ -21378,7 +22764,7 @@ } }, { - "id": 334, + "id": 339, "name": "storage", "kind": 1024, "kindString": "Property", @@ -21388,16 +22774,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 49, "character": 2 } ], "type": { "type": "reference", - "id": 756, + "id": 776, "name": "SupportedStorage", "dereferenced": { - "id": 756, + "id": 776, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -21405,7 +22791,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 929, + "line": 955, "character": 12 } ], @@ -21450,7 +22836,7 @@ } }, { - "id": 330, + "id": 335, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -21460,7 +22846,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 40, + "line": 41, "character": 2 } ], @@ -21470,7 +22856,7 @@ } }, { - "id": 325, + "id": 330, "name": "url", "kind": 1024, "kindString": "Property", @@ -21480,7 +22866,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 36, + "line": 37, "character": 2 } ], @@ -21494,13 +22880,23 @@ { "title": "Properties", "kind": 1024, - "children": [332, 331, 335, 336, 326, 333, 334, 330, 325] + "children": [ + 337, + 336, + 340, + 341, + 331, + 338, + 339, + 335, + 330 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 35, "character": 34 } ] @@ -21508,7 +22904,7 @@ } }, { - "id": 757, + "id": 777, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -21516,21 +22912,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 931, + "line": 957, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 758, + "id": 778, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 759, + "id": 779, "name": "error", "kind": 1024, "kindString": "Property", @@ -21538,7 +22934,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 931, + "line": 957, "character": 33 } ], @@ -21547,7 +22943,7 @@ "types": [ { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" }, { @@ -21562,13 +22958,15 @@ { "title": "Properties", "kind": 1024, - "children": [759] + "children": [ + 779 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 931, + "line": 957, "character": 31 } ] @@ -21576,7 +22974,7 @@ } }, { - "id": 631, + "id": 651, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -21584,21 +22982,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 632, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 634, + "id": 654, "name": "code", "kind": 1024, "kindString": "Property", @@ -21609,7 +23007,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 661, + "line": 687, "character": 2 } ], @@ -21619,7 +23017,7 @@ } }, { - "id": 633, + "id": 653, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -21630,7 +23028,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 685, "character": 2 } ], @@ -21644,13 +23042,16 @@ { "title": "Properties", "kind": 1024, - "children": [634, 633] + "children": [ + 654, + 653 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 683, "character": 42 } ] @@ -21658,7 +23059,7 @@ } }, { - "id": 628, + "id": 648, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -21666,21 +23067,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 629, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 630, + "id": 650, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -21691,7 +23092,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 680, "character": 2 } ], @@ -21705,13 +23106,15 @@ { "title": "Properties", "kind": 1024, - "children": [630] + "children": [ + 650 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 678, "character": 33 } ] @@ -21719,7 +23122,7 @@ } }, { - "id": 615, + "id": 635, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -21727,21 +23130,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 636, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 617, + "id": 637, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -21752,7 +23155,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 629, + "line": 655, "character": 2 } ], @@ -21762,7 +23165,7 @@ } }, { - "id": 619, + "id": 639, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -21775,7 +23178,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 633, + "line": 659, "character": 2 } ], @@ -21785,7 +23188,7 @@ } }, { - "id": 618, + "id": 638, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -21798,7 +23201,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 631, + "line": 657, "character": 2 } ], @@ -21812,13 +23215,17 @@ { "title": "Properties", "kind": 1024, - "children": [617, 619, 618] + "children": [ + 637, + 639, + 638 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 627, + "line": 653, "character": 30 } ] @@ -21826,7 +23233,7 @@ } }, { - "id": 620, + "id": 640, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -21834,21 +23241,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 621, + "id": 641, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 622, + "id": 642, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -21859,7 +23266,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 638, + "line": 664, "character": 2 } ], @@ -21873,13 +23280,15 @@ { "title": "Properties", "kind": 1024, - "children": [622] + "children": [ + 642 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 636, + "line": 662, "character": 32 } ] @@ -21887,7 +23296,7 @@ } }, { - "id": 623, + "id": 643, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -21895,21 +23304,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 644, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 626, + "id": 646, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -21920,7 +23329,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 672, "character": 2 } ], @@ -21930,7 +23339,7 @@ } }, { - "id": 627, + "id": 647, "name": "code", "kind": 1024, "kindString": "Property", @@ -21941,7 +23350,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 675, "character": 2 } ], @@ -21951,7 +23360,7 @@ } }, { - "id": 625, + "id": 645, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -21962,7 +23371,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 669, "character": 2 } ], @@ -21976,13 +23385,17 @@ { "title": "Properties", "kind": 1024, - "children": [626, 627, 625] + "children": [ + 646, + 647, + 645 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 641, + "line": 667, "character": 30 } ] @@ -21990,7 +23403,7 @@ } }, { - "id": 553, + "id": 560, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -21998,7 +23411,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 513, "character": 12 } ], @@ -22017,7 +23430,7 @@ } }, { - "id": 350, + "id": 355, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -22025,7 +23438,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 71, + "line": 72, "character": 12 } ], @@ -22035,14 +23448,14 @@ { "type": "reflection", "declaration": { - "id": 351, + "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 352, + "id": 357, "name": "data", "kind": 1024, "kindString": "Property", @@ -22050,21 +23463,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 74, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 353, + "id": 358, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 359, "name": "provider", "kind": 1024, "kindString": "Property", @@ -22072,18 +23485,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 75, "character": 8 } ], "type": { "type": "reference", - "id": 320, + "id": 325, "name": "Provider" } }, { - "id": 355, + "id": 360, "name": "url", "kind": 1024, "kindString": "Property", @@ -22091,7 +23504,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 75, + "line": 76, "character": 8 } ], @@ -22105,13 +23518,16 @@ { "title": "Properties", "kind": 1024, - "children": [354, 355] + "children": [ + 359, + 360 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 74, "character": 12 } ] @@ -22119,7 +23535,7 @@ } }, { - "id": 356, + "id": 361, "name": "error", "kind": 1024, "kindString": "Property", @@ -22127,7 +23543,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 78, "character": 6 } ], @@ -22141,13 +23557,16 @@ { "title": "Properties", "kind": 1024, - "children": [352, 356] + "children": [ + 357, + 361 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 73, "character": 4 } ] @@ -22156,14 +23575,14 @@ { "type": "reflection", "declaration": { - "id": 357, + "id": 362, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 358, + "id": 363, "name": "data", "kind": 1024, "kindString": "Property", @@ -22171,21 +23590,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, + "line": 81, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 359, + "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 360, + "id": 365, "name": "provider", "kind": 1024, "kindString": "Property", @@ -22193,18 +23612,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 81, + "line": 82, "character": 8 } ], "type": { "type": "reference", - "id": 320, + "id": 325, "name": "Provider" } }, { - "id": 361, + "id": 366, "name": "url", "kind": 1024, "kindString": "Property", @@ -22212,7 +23631,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 83, "character": 8 } ], @@ -22226,13 +23645,16 @@ { "title": "Properties", "kind": 1024, - "children": [360, 361] + "children": [ + 365, + 366 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, + "line": 81, "character": 12 } ] @@ -22240,7 +23662,7 @@ } }, { - "id": 362, + "id": 367, "name": "error", "kind": 1024, "kindString": "Property", @@ -22248,13 +23670,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 84, + "line": 85, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -22263,13 +23685,16 @@ { "title": "Properties", "kind": 1024, - "children": [358, 362] + "children": [ + 363, + 367 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, + "line": 80, "character": 4 } ] @@ -22279,7 +23704,7 @@ } }, { - "id": 774, + "id": 794, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -22287,21 +23712,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 775, + "id": 795, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 796, "name": "page", "kind": 1024, "kindString": "Property", @@ -22314,7 +23739,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 952, + "line": 978, "character": 2 } ], @@ -22324,7 +23749,7 @@ } }, { - "id": 777, + "id": 797, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -22337,7 +23762,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 954, + "line": 980, "character": 2 } ], @@ -22351,13 +23776,16 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777] + "children": [ + 796, + 797 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 950, + "line": 976, "character": 25 } ] @@ -22365,7 +23793,7 @@ } }, { - "id": 767, + "id": 787, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -22373,21 +23801,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 943, + "line": 969, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 770, + "id": 790, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -22395,7 +23823,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 946, + "line": 972, "character": 2 } ], @@ -22405,7 +23833,7 @@ } }, { - "id": 769, + "id": 789, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -22413,7 +23841,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 945, + "line": 971, "character": 2 } ], @@ -22432,7 +23860,7 @@ } }, { - "id": 771, + "id": 791, "name": "total", "kind": 1024, "kindString": "Property", @@ -22440,7 +23868,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 947, + "line": 973, "character": 2 } ], @@ -22454,25 +23882,29 @@ { "title": "Properties", "kind": 1024, - "children": [770, 769, 771] + "children": [ + 790, + 789, + 791 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 943, + "line": 969, "character": 25 } ], "indexSignature": { - "id": 772, + "id": 792, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 773, + "id": 793, "name": "key", "kind": 32768, "flags": {}, @@ -22491,7 +23923,7 @@ } }, { - "id": 320, + "id": 325, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -22572,20 +24004,24 @@ { "type": "literal", "value": "workos" + }, + { + "type": "literal", + "value": "zoom" } ] } }, { - "id": 363, - "name": "SSOResponse", + "id": 562, + "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 87, + "line": 516, "character": 12 } ], @@ -22595,48 +24031,69 @@ { "type": "reflection", "declaration": { - "id": 364, + "id": 563, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, - "name": "data", + "id": 565, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, + "line": 519, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 566, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 366, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 367, - "name": "url", + "id": 568, + "name": "captchaToken", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "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" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 522, "character": 8 } ], @@ -22650,35 +24107,59 @@ { "title": "Properties", "kind": 1024, - "children": [367] + "children": [ + 568 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, - "character": 12 + "line": 520, + "character": 16 } ] } } }, { - "id": 368, - "name": "error", + "id": 564, + "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 99, + "line": 518, "character": 6 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 561, + "name": "EmailOtpType" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "signup" + }, + { + "type": "literal", + "value": "email_change" + } + ] + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" } } ], @@ -22686,18 +24167,196 @@ { "title": "Properties", "kind": 1024, - "children": [365, 368] + "children": [ + 565, + 566, + 564 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, + "line": 517, "character": 4 } ] } }, + { + "type": "reflection", + "declaration": { + "id": 569, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 572, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 573, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 574, + "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": 530, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 574 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 528, + "character": 16 + } + ] + } + } + }, + { + "id": 571, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 527, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 570, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 526, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 560, + "name": "MobileOtpType" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "phone" + } + ] + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 572, + 571, + 570 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 525, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 368, + "name": "SSOResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ { "type": "reflection", "declaration": { @@ -22716,7 +24375,71 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 102, + "line": 90, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 371, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 372, + "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": 98, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 372 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 12 + } + ] + } + } + }, + { + "id": 373, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, "character": 6 } ], @@ -22724,10 +24447,39 @@ "type": "literal", "value": null } - }, + } + ], + "groups": [ { - "id": 371, - "name": "error", + "title": "Properties", + "kind": 1024, + "children": [ + 370, + 373 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 89, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 374, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 375, + "name": "data", "kind": 1024, "kindString": "Property", "flags": {}, @@ -22738,9 +24490,27 @@ "character": 6 } ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 376, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 6 + } + ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -22749,13 +24519,16 @@ { "title": "Properties", "kind": 1024, - "children": [370, 371] + "children": [ + 375, + 376 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 101, + "line": 102, "character": 4 } ] @@ -22765,7 +24538,7 @@ } }, { - "id": 528, + "id": 535, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -22773,21 +24546,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 463, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 529, + "id": 536, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 532, + "id": 539, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -22800,7 +24573,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 463, + "line": 471, "character": 2 } ], @@ -22810,7 +24583,7 @@ } }, { - "id": 533, + "id": 540, "name": "options", "kind": 1024, "kindString": "Property", @@ -22820,21 +24593,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 472, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 534, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 535, + "id": 542, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22847,7 +24620,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 466, + "line": 474, "character": 4 } ], @@ -22861,13 +24634,15 @@ { "title": "Properties", "kind": 1024, - "children": [535] + "children": [ + 542 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 472, "character": 12 } ] @@ -22875,7 +24650,7 @@ } }, { - "id": 530, + "id": 537, "name": "provider", "kind": 1024, "kindString": "Property", @@ -22886,7 +24661,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 459, + "line": 467, "character": 2 } ], @@ -22905,7 +24680,7 @@ } }, { - "id": 531, + "id": 538, "name": "token", "kind": 1024, "kindString": "Property", @@ -22916,7 +24691,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 461, + "line": 469, "character": 2 } ], @@ -22930,13 +24705,18 @@ { "title": "Properties", "kind": 1024, - "children": [532, 533, 530, 531] + "children": [ + 539, + 540, + 537, + 538 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 463, "character": 43 } ] @@ -22944,7 +24724,7 @@ } }, { - "id": 516, + "id": 523, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -22952,21 +24732,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 448, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 517, + "id": 524, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 526, "name": "options", "kind": 1024, "kindString": "Property", @@ -22976,21 +24756,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 443, + "line": 451, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 520, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 523, + "id": 530, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -23003,14 +24783,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 449, + "line": 457, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 524, + "id": 531, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -23018,19 +24798,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 449, + "line": 457, "character": 18 } ], "indexSignature": { - "id": 525, + "id": 532, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 526, + "id": 533, "name": "key", "kind": 32768, "flags": {}, @@ -23049,7 +24829,7 @@ } }, { - "id": 521, + "id": 528, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -23062,7 +24842,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 445, + "line": 453, "character": 4 } ], @@ -23072,7 +24852,7 @@ } }, { - "id": 522, + "id": 529, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -23085,7 +24865,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 447, + "line": 455, "character": 4 } ], @@ -23095,7 +24875,7 @@ } }, { - "id": 527, + "id": 534, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -23108,7 +24888,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 451, + "line": 459, "character": 4 } ], @@ -23122,13 +24902,18 @@ { "title": "Properties", "kind": 1024, - "children": [523, 521, 522, 527] + "children": [ + 530, + 528, + 529, + 534 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 443, + "line": 451, "character": 12 } ] @@ -23136,7 +24921,7 @@ } }, { - "id": 518, + "id": 525, "name": "provider", "kind": 1024, "kindString": "Property", @@ -23147,16 +24932,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 442, + "line": 450, "character": 2 } ], "type": { "type": "reference", - "id": 320, + "id": 325, "name": "Provider", "dereferenced": { - "id": 320, + "id": 325, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -23237,6 +25022,10 @@ { "type": "literal", "value": "workos" + }, + { + "type": "literal", + "value": "zoom" } ] } @@ -23248,13 +25037,16 @@ { "title": "Properties", "kind": 1024, - "children": [519, 518] + "children": [ + 526, + 525 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 448, "character": 41 } ] @@ -23262,7 +25054,7 @@ } }, { - "id": 484, + "id": 491, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -23270,7 +25062,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 373, + "line": 381, "character": 12 } ], @@ -23280,14 +25072,14 @@ { "type": "reflection", "declaration": { - "id": 485, + "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 486, + "id": 493, "name": "email", "kind": 1024, "kindString": "Property", @@ -23298,7 +25090,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 376, + "line": 384, "character": 6 } ], @@ -23308,7 +25100,7 @@ } }, { - "id": 488, + "id": 495, "name": "options", "kind": 1024, "kindString": "Property", @@ -23318,126 +25110,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 379, + "line": 387, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 489, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 490, - "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": 381, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [490] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 379, - "character": 16 - } - ] - } - } - }, - { - "id": 487, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 378, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [486, 488, 487] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 374, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 491, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 494, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 389, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 495, + "id": 496, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -23457,7 +25137,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 397, + "line": 389, "character": 8 } ], @@ -23465,43 +25145,21 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 496, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 395, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [497, 496] + "children": [ + 497 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 389, + "line": 387, "character": 16 } ] @@ -23509,7 +25167,7 @@ } }, { - "id": 493, + "id": 494, "name": "password", "kind": 1024, "kindString": "Property", @@ -23517,27 +25175,6 @@ "comment": { "shortText": "The user's password." }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 388, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 492, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -23555,67 +25192,31 @@ { "title": "Properties", "kind": 1024, - "children": [494, 493, 492] + "children": [ + 493, + 495, + 494 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 384, + "line": 382, "character": 4 } ] } - } - ] - } - }, - { - "id": 498, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 401, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ + }, { "type": "reflection", "declaration": { - "id": 499, + "id": 498, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ - { - "id": 500, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 404, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 501, "name": "options", @@ -23627,7 +25228,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 397, "character": 6 } ], @@ -23641,7 +25242,7 @@ "flags": {}, "children": [ { - "id": 506, + "id": 504, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23654,7 +25255,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 417, + "line": 405, "character": 8 } ], @@ -23664,7 +25265,7 @@ } }, { - "id": 505, + "id": 503, "name": "data", "kind": 1024, "kindString": "Property", @@ -23678,7 +25279,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 415, + "line": 403, "character": 8 } ], @@ -23686,99 +25287,142 @@ "type": "intrinsic", "name": "object" } - }, - { - "id": 503, - "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": 407, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 504, - "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": 409, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [506, 505, 503, 504] + "children": [ + 504, + 503 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 397, "character": 16 } ] } } + }, + { + "id": 500, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 396, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 499, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 394, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [500, 501] + "children": [ + 501, + 500, + 499 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 402, + "line": 392, "character": 4 } ] } - }, + } + ] + } + }, + { + "id": 505, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 409, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ { "type": "reflection", "declaration": { - "id": 507, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 509, + "id": 507, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 412, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 508, "name": "options", "kind": 1024, "kindString": "Property", @@ -23788,14 +25432,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 423, + "line": 413, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 510, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -23815,7 +25459,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 425, "character": 8 } ], @@ -23824,38 +25468,6 @@ "name": "string" } }, - { - "id": 514, - "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": 435, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, { "id": 512, "name": "data", @@ -23871,7 +25483,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 431, + "line": 423, "character": 8 } ], @@ -23880,6 +25492,29 @@ "name": "object" } }, + { + "id": 510, + "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": 415, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, { "id": 511, "name": "shouldCreateUser", @@ -23894,7 +25529,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 425, + "line": 417, "character": 8 } ], @@ -23908,206 +25543,39 @@ { "title": "Properties", "kind": 1024, - "children": [513, 514, 512, 511] + "children": [ + 513, + 512, + 510, + 511 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 423, + "line": 413, "character": 16 } ] } } - }, - { - "id": 508, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 422, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [509, 508] + "children": [ + 507, + 508 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 420, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 555, - "name": "SignInWithSSO", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 508, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 558, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 513, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 559, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 561, - "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": 517, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 560, - "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": 515, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [561, 560] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 513, - "character": 16 - } - ] - } - } - }, - { - "id": 557, - "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": 511, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [558, 557] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 509, + "line": 410, "character": 4 } ] @@ -24116,35 +25584,14 @@ { "type": "reflection", "declaration": { - "id": 562, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 563, - "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": 522, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 564, + "id": 516, "name": "options", "kind": 1024, "kindString": "Property", @@ -24154,21 +25601,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 524, + "line": 431, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 565, + "id": 517, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 567, + "id": 520, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -24181,7 +25628,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 528, + "line": 441, "character": 8 } ], @@ -24191,320 +25638,7 @@ } }, { - "id": 566, - "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": 526, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [567, 566] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 524, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [563, 564] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 467, - "name": "SignUpWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 336, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 469, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 471, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 472, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 475, - "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": 352, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 474, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 473, - "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": 344, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [475, 474, 473] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 16 - } - ] - } - } - }, - { - "id": 470, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [469, 471, 470] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 476, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 479, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 360, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 482, - "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": 368, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 483, + "id": 521, "name": "channel", "kind": 1024, "kindString": "Property", @@ -24517,7 +25651,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 370, + "line": 443, "character": 8 } ], @@ -24535,6 +25669,514 @@ ] } }, + { + "id": 519, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 439, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 518, + "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": 433, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 520, + 521, + 519, + 518 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 431, + "character": 16 + } + ] + } + } + }, + { + "id": 515, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 430, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 516, + 515 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 428, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 575, + "name": "SignInWithSSO", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 534, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 576, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 578, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 539, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 579, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 581, + "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": 543, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 580, + "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": 541, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 581, + 580 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 539, + "character": 16 + } + ] + } + } + }, + { + "id": 577, + "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": 537, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 578, + 577 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 535, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 582, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 583, + "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": 548, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 584, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 550, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 585, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 587, + "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": 554, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 586, + "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": 552, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 587, + 586 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 550, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 583, + 584 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 546, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 474, + "name": "SignUpWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 475, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 476, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 478, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 350, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 479, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 482, + "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": 360, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, { "id": 481, "name": "data", @@ -24550,7 +26192,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 358, "character": 8 } ], @@ -24558,19 +26200,46 @@ "type": "intrinsic", "name": "object" } + }, + { + "id": 480, + "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": 352, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [482, 483, 481] + "children": [ + 482, + 481, + 480 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 360, + "line": 350, "character": 16 } ] @@ -24578,7 +26247,7 @@ } }, { - "id": 478, + "id": 477, "name": "password", "kind": 1024, "kindString": "Property", @@ -24589,28 +26258,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 477, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 357, + "line": 349, "character": 6 } ], @@ -24624,13 +26272,214 @@ { "title": "Properties", "kind": 1024, - "children": [479, 478, 477] + "children": [ + 476, + 478, + 477 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 355, + "line": 345, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 483, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 486, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 487, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 489, + "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": 376, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 490, + "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": 378, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 488, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 374, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 489, + 490, + 488 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 16 + } + ] + } + } + }, + { + "id": 485, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 367, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 484, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 365, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 486, + 485, + 484 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 363, "character": 4 } ] @@ -24640,7 +26489,7 @@ } }, { - "id": 756, + "id": 776, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -24648,7 +26497,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 929, + "line": 955, "character": 12 } ], @@ -24691,7 +26540,7 @@ } }, { - "id": 372, + "id": 377, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -24699,116 +26548,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 106, + "line": 107, "character": 12 } ], "type": { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 373, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 374, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 376, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 420, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [376] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 12 - } - ] - } - } - }, - { - "id": 377, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [374, 377] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 4 - } - ] - } - }, { "type": "reflection", "declaration": { @@ -24827,7 +26573,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 114, + "line": 109, "character": 6 } ], @@ -24849,13 +26595,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 115, + "line": 110, "character": 8 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 425, + "name": "User" } } ], @@ -24863,13 +26610,15 @@ { "title": "Properties", "kind": 1024, - "children": [381] + "children": [ + 381 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 114, + "line": 109, "character": 12 } ] @@ -24885,13 +26634,120 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 117, + "line": 112, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 379, + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 383, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 384, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 385, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 386, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 386 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 12 + } + ] + } + } + }, + { + "id": 387, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, "character": 6 } ], "type": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -24900,13 +26756,16 @@ { "title": "Properties", "kind": 1024, - "children": [379, 382] + "children": [ + 384, + 387 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, + "line": 114, "character": 4 } ] @@ -24916,7 +26775,7 @@ } }, { - "id": 536, + "id": 543, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -24924,7 +26783,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 470, + "line": 478, "character": 12 } ], @@ -24932,14 +26791,14 @@ "type": "union", "types": [ { - "id": 537, + "id": 544, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 541, + "id": 548, "name": "options", "kind": 1024, "kindString": "Property", @@ -24949,21 +26808,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 478, + "line": 486, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 542, + "id": 549, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 551, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -24982,7 +26841,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 495, "character": 4 } ], @@ -24992,7 +26851,7 @@ } }, { - "id": 543, + "id": 550, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -25005,7 +26864,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 480, + "line": 488, "character": 4 } ], @@ -25019,14 +26878,17 @@ { "title": "Properties", "kind": 1024, - "children": [544, 543] + "children": [ + 551, + 550 + ] } ] } } }, { - "id": 538, + "id": 545, "name": "phone", "kind": 1024, "kindString": "Property", @@ -25037,7 +26899,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 473, + "line": 481, "character": 2 } ], @@ -25047,7 +26909,7 @@ } }, { - "id": 539, + "id": 546, "name": "token", "kind": 1024, "kindString": "Property", @@ -25058,7 +26920,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 475, + "line": 483, "character": 2 } ], @@ -25068,7 +26930,7 @@ } }, { - "id": 540, + "id": 547, "name": "type", "kind": 1024, "kindString": "Property", @@ -25079,16 +26941,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 477, + "line": 485, "character": 2 } ], "type": { "type": "reference", - "id": 553, + "id": 560, "name": "MobileOtpType", "dereferenced": { - "id": 553, + "id": 560, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -25096,7 +26958,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 513, "character": 12 } ], @@ -25121,26 +26983,31 @@ { "title": "Properties", "kind": 1024, - "children": [541, 538, 539, 540] + "children": [ + 548, + 545, + 546, + 547 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 479, "character": 17 } ] }, { - "id": 545, + "id": 552, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 546, + "id": 553, "name": "email", "kind": 1024, "kindString": "Property", @@ -25151,7 +27018,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 492, + "line": 500, "character": 2 } ], @@ -25161,7 +27028,7 @@ } }, { - "id": 549, + "id": 556, "name": "options", "kind": 1024, "kindString": "Property", @@ -25171,21 +27038,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 497, + "line": 505, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 550, + "id": 557, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 559, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -25198,7 +27065,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 501, + "line": 509, "character": 4 } ], @@ -25208,7 +27075,7 @@ } }, { - "id": 551, + "id": 558, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -25221,7 +27088,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 499, + "line": 507, "character": 4 } ], @@ -25235,14 +27102,17 @@ { "title": "Properties", "kind": 1024, - "children": [552, 551] + "children": [ + 559, + 558 + ] } ] } } }, { - "id": 547, + "id": 554, "name": "token", "kind": 1024, "kindString": "Property", @@ -25253,7 +27123,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 494, + "line": 502, "character": 2 } ], @@ -25263,7 +27133,7 @@ } }, { - "id": 548, + "id": 555, "name": "type", "kind": 1024, "kindString": "Property", @@ -25274,16 +27144,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 496, + "line": 504, "character": 2 } ], "type": { "type": "reference", - "id": 554, + "id": 561, "name": "EmailOtpType", "dereferenced": { - "id": 554, + "id": 561, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -25291,7 +27161,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 514, "character": 12 } ], @@ -25332,13 +27202,18 @@ { "title": "Properties", "kind": 1024, - "children": [546, 549, 547, 548] + "children": [ + 553, + 556, + 554, + 555 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 490, + "line": 498, "character": 17 } ] @@ -25347,7 +27222,7 @@ } }, { - "id": 781, + "id": 801, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -25361,14 +27236,14 @@ ], "signatures": [ { - "id": 782, + "id": 802, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 783, + "id": 803, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -25385,7 +27260,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 791, + "id": 811, "name": "AuthApiError" } } @@ -25393,7 +27268,7 @@ ] }, { - "id": 778, + "id": 798, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -25407,14 +27282,14 @@ ], "signatures": [ { - "id": 779, + "id": 799, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 780, + "id": 800, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -25431,7 +27306,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 784, + "id": 804, "name": "AuthError" } } @@ -25443,26 +27318,103 @@ { "title": "Classes", "kind": 128, - "children": [791, 784, 852, 839, 877, 902, 827, 804, 812, 1, 77] + "children": [ + 811, + 804, + 872, + 859, + 897, + 922, + 847, + 824, + 832, + 1, + 77 + ] }, { "title": "Interfaces", "kind": 256, - "children": [392, 448, 406, 590, 749, 704, 383, 457, 465, 420, 413, 443, 395, 417, 545, 537] + "children": [ + 397, + 454, + 411, + 610, + 769, + 724, + 388, + 464, + 472, + 425, + 418, + 448, + 400, + 422, + 552, + 544 + ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 322, 321, 515, 733, 724, 746, 737, 672, 648, 693, 682, 663, 635, 337, 692, 760, 554, 584, - 574, 593, 607, 594, 614, 579, 568, 323, 757, 631, 628, 615, 620, 623, 553, 350, 774, 767, - 320, 363, 528, 516, 484, 498, 555, 467, 756, 372, 536 + 327, + 326, + 522, + 753, + 744, + 766, + 757, + 692, + 668, + 713, + 702, + 683, + 655, + 342, + 712, + 780, + 561, + 604, + 594, + 613, + 627, + 614, + 634, + 599, + 588, + 328, + 777, + 651, + 648, + 635, + 640, + 643, + 560, + 355, + 794, + 787, + 325, + 562, + 368, + 535, + 523, + 491, + 505, + 575, + 474, + 776, + 377, + 543 ] }, { "title": "Functions", "kind": 64, - "children": [781, 778] + "children": [ + 801, + 798 + ] } ], "sources": [ @@ -25472,4 +27424,4 @@ "character": 0 } ] -} +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/postgrest.json b/spec/enrichments/tsdoc_v2/postgrest.json index 213e7ae6625..667700a2d8c 100644 --- a/spec/enrichments/tsdoc_v2/postgrest.json +++ b/spec/enrichments/tsdoc_v2/postgrest.json @@ -1,13209 +1,13428 @@ { - "id": 0, - "name": "@supabase/postgrest-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 536, - "name": "PostgrestBuilder", - "kind": 128, - "kindString": "Class", - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 537, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 18, - "character": 2 - } - ], - "signatures": [ - { - "id": 538, - "name": "new PostgrestBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 539, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 540, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "id": 539, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "id": 539, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 553, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 545, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 548, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 549, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 550, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 551, - "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": 552, - "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": 543, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 541, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 544, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 546, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 547, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - }, - { - "id": 542, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - }, - { - "id": 556, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 557, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 558, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 539, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 559, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 560, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 561, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 562, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 563, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 539, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 564, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 565, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 566, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 567, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 425, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 425, - "name": "TResult2" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - }, - { - "type": "reference", - "id": 425, - "name": "TResult2" - } - ] - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "implementationOf": { - "type": "reference", - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "name": "PromiseLike.then" - } - }, - { - "id": 554, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 555, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" - }, - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "id": 539, - "name": "Result" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [537] - }, - { - "title": "Properties", - "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] - }, - { - "title": "Methods", - "kind": 2048, - "children": [556, 554] - } - ], - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 5, - "character": 30 - } - ], - "typeParameter": [ - { - "id": 568, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 437, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 539, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - }, - { - "id": 1, - "name": "PostgrestClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "PostgREST client." - }, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 41, - "character": 2 - } - ], - "signatures": [ - { - "id": 3, - "name": "new PostgrestClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Creates a PostgREST client." - }, - "typeParameter": [ - { - "id": 4, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 6, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 7, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "URL of the PostgREST endpoint" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 8, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 12, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 50, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 13, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 14, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Custom fetch\n" - }, - "parameters": [ - { - "id": 15, - "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": 16, - "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": 10, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Custom headers" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 48, - "character": 6 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 11, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Postgres schema to switch to" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 49, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [12, 10, 11] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 1, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 6, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 20, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 22, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 23, - "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": 24, - "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": 18, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 27, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 19, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 28, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - }, - { - "id": 17, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 26, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 25, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 26, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a query on a table or a view." - }, - "typeParameter": [ - { - "id": 27, - "name": "TableName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 28, - "name": "Table", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericTable" - } - } - ], - "parameters": [ - { - "id": 29, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The table or view name to query\n" - }, - "type": { - "type": "reference", - "id": 27, - "name": "TableName" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "reference", - "id": 28, - "name": "Table" - } - ], - "name": "default" - } - }, - { - "id": 30, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a query on a table or a view." - }, - "typeParameter": [ - { - "id": 31, - "name": "ViewName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "View", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericView" - } - } - ], - "parameters": [ - { - "id": 33, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The table or view name to query\n" - }, - "type": { - "type": "reference", - "id": 31, - "name": "ViewName" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "reference", - "id": 32, - "name": "View" - } - ], - "name": "default" - } - }, - { - "id": 34, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a query on a table or a view." - }, - "parameters": [ - { - "id": 35, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The table or view name to query\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 36, - "name": "rpc", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 102, - "character": 2 - } - ], - "signatures": [ - { - "id": 37, - "name": "rpc", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a function call." - }, - "typeParameter": [ - { - "id": 38, - "name": "FunctionName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "Function_", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericFunction" - } - } - ], - "parameters": [ - { - "id": 40, - "name": "fn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The function name to call" - }, - "type": { - "type": "reference", - "id": 38, - "name": "FunctionName" - } - }, - { - "id": 41, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The arguments to pass to the function call" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Args" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - }, - "defaultValue": "{}" - }, - { - "id": 42, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 43, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 45, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 113, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 44, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 112, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [45, 44] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - } - }, - "extendsType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [2] - }, - { - "title": "Properties", - "kind": 1024, - "children": [20, 18, 19, 17] - }, - { - "title": "Methods", - "kind": 2048, - "children": [25, 36] - } - ], - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 17, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 46, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" - }, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 47, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 48, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 114, - "name": "PostgrestFilterBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 115, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "signatures": [ - { - "id": 116, - "name": "new PostgrestFilterBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 117, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 118, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 119, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 120, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 439, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 438, - "name": "default.constructor" - } - }, - { - "id": 419, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 518, - "name": "default.allowEmpty" - } - }, - { - "id": 411, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "id": 510, - "name": "default.body" - } - }, - { - "id": 414, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 415, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 416, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 417, - "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": 418, - "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" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 513, - "name": "default.fetch" - } - }, - { - "id": 409, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "inheritedFrom": { - "type": "reference", - "id": 508, - "name": "default.headers" - } - }, - { - "id": 407, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 506, - "name": "default.method" - } - }, - { - "id": 410, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 509, - "name": "default.schema" - } - }, - { - "id": 412, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 511, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 413, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - }, - "inheritedFrom": { - "type": "reference", - "id": 512, - "name": "default.signal" - } - }, - { - "id": 408, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - }, - "inheritedFrom": { - "type": "reference", - "id": 507, - "name": "default.url" - } - }, - { - "id": 379, - "name": "abortSignal", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 125, - "character": 2 - } - ], - "signatures": [ - { - "id": 380, - "name": "abortSignal", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Set the AbortSignal for the fetch request." - }, - "parameters": [ - { - "id": 381, - "name": "signal", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" - }, - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 479, - "name": "default.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 478, - "name": "default.abortSignal" - } - }, - { - "id": 241, - "name": "containedBy", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 261, - "character": 2 - } - ], - "signatures": [ - { - "id": 242, - "name": "containedBy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." - }, - "typeParameter": [ - { - "id": 243, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 244, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range column to filter on" - }, - "type": { - "type": "reference", - "id": 243, - "name": "ColumnName" - } - }, - { - "id": 245, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 243, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 246, - "name": "containedBy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." - }, - "parameters": [ - { - "id": 247, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 248, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 233, - "name": "contains", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 234, - "character": 2 - } - ], - "signatures": [ - { - "id": 234, - "name": "contains", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." - }, - "typeParameter": [ - { - "id": 235, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 236, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range column to filter on" - }, - "type": { - "type": "reference", - "id": 235, - "name": "ColumnName" - } - }, - { - "id": 237, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 235, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 238, - "name": "contains", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." - }, - "parameters": [ - { - "id": 239, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 240, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 388, - "name": "csv", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, - "character": 2 - } - ], - "signatures": [ - { - "id": 389, - "name": "csv", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a string in CSV format." - }, - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 488, - "name": "default.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 487, - "name": "default.csv" - } - }, - { - "id": 121, - "name": "eq", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 33, - "character": 2 - } - ], - "signatures": [ - { - "id": 122, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" - }, - "typeParameter": [ - { - "id": 123, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 124, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 123, - "name": "ColumnName" - } - }, - { - "id": 125, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 123, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 126, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" - }, - "parameters": [ - { - "id": 127, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 128, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 392, - "name": "explain", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 194, - "character": 2 - } - ], - "signatures": [ - { - "id": 393, - "name": "explain", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query." - }, - "parameters": [ - { - "id": 394, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 395, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 396, - "name": "analyze", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 202, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 399, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on buffer usage\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 401, - "name": "format", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 398, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 397, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 400, - "name": "wal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on WAL record generation\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [396, 399, 401, 398, 397, 400] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "default" - }, - { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "name": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 492, - "name": "default.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 491, - "name": "default.explain" - } - }, - { - "id": 335, - "name": "filter", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 480, - "character": 2 - } - ], - "signatures": [ - { - "id": 336, - "name": "filter", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" - }, - "typeParameter": [ - { - "id": 337, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 338, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 337, - "name": "ColumnName" - } - }, - { - "id": 339, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "FilterOperator" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - } - ] - } - }, - { - "id": 340, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 341, - "name": "filter", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" - }, - "parameters": [ - { - "id": 342, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 343, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 390, - "name": "geojson", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, - "character": 2 - } - ], - "signatures": [ - { - "id": 391, - "name": "geojson", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." - }, - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 490, - "name": "default.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 489, - "name": "default.geojson" - } - }, - { - "id": 137, - "name": "gt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 61, - "character": 2 - } - ], - "signatures": [ - { - "id": 138, - "name": "gt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is greater than `value`." - }, - "typeParameter": [ - { - "id": 139, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 140, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 139, - "name": "ColumnName" - } - }, - { - "id": 141, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 139, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 142, - "name": "gt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is greater than `value`." - }, - "parameters": [ - { - "id": 143, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 144, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 145, - "name": "gte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 74, - "character": 2 - } - ], - "signatures": [ - { - "id": 146, - "name": "gte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." - }, - "typeParameter": [ - { - "id": 147, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 148, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 147, - "name": "ColumnName" - } - }, - { - "id": 149, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 147, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 150, - "name": "gte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." - }, - "parameters": [ - { - "id": 151, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 152, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 193, - "name": "ilike", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 152, - "character": 2 - } - ], - "signatures": [ - { - "id": 194, - "name": "ilike", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." - }, - "typeParameter": [ - { - "id": 195, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 196, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 195, - "name": "ColumnName" - } - }, - { - "id": 197, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The pattern to match with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 198, - "name": "ilike", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." - }, - "parameters": [ - { - "id": 199, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 200, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The pattern to match with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 201, - "name": "ilikeAllOf", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 165, - "character": 2 - } - ], - "signatures": [ - { - "id": 202, - "name": "ilikeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." - }, - "typeParameter": [ - { - "id": 203, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 204, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 203, - "name": "ColumnName" - } - }, - { - "id": 205, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 206, - "name": "ilikeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." - }, - "parameters": [ - { - "id": 207, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 208, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 209, - "name": "ilikeAnyOf", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 178, - "character": 2 - } - ], - "signatures": [ - { - "id": 210, - "name": "ilikeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." - }, - "typeParameter": [ - { - "id": 211, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 212, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 211, - "name": "ColumnName" - } - }, - { - "id": 213, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 214, - "name": "ilikeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." - }, - "parameters": [ - { - "id": 215, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 216, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 225, - "name": "in", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 226, - "name": "in", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." - }, - "typeParameter": [ - { - "id": 227, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 228, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 227, - "name": "ColumnName" - } - }, - { - "id": 229, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values array to filter with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 227, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 230, - "name": "in", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." - }, - "parameters": [ - { - "id": 231, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 232, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values array to filter with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 217, - "name": "is", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 191, - "character": 2 - } - ], - "signatures": [ - { - "id": 218, - "name": "is", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" - }, - "typeParameter": [ - { - "id": 219, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 220, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 219, - "name": "ColumnName" - } - }, - { - "id": 221, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 219, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 219, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - }, - { - "type": "literal", - "value": false - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 219, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - }, - { - "type": "literal", - "value": true - } - ] - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 222, - "name": "is", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" - }, - "parameters": [ - { - "id": 223, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 224, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 169, - "name": "like", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 113, - "character": 2 - } - ], - "signatures": [ - { - "id": 170, - "name": "like", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." - }, - "typeParameter": [ - { - "id": 171, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 172, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 171, - "name": "ColumnName" - } - }, - { - "id": 173, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The pattern to match with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 174, - "name": "like", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." - }, - "parameters": [ - { - "id": 175, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 176, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The pattern to match with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 177, - "name": "likeAllOf", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 126, - "character": 2 - } - ], - "signatures": [ - { - "id": 178, - "name": "likeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." - }, - "typeParameter": [ - { - "id": 179, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 180, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 179, - "name": "ColumnName" - } - }, - { - "id": 181, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 182, - "name": "likeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." - }, - "parameters": [ - { - "id": 183, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 184, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 185, - "name": "likeAnyOf", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 139, - "character": 2 - } - ], - "signatures": [ - { - "id": 186, - "name": "likeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." - }, - "typeParameter": [ - { - "id": 187, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 188, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 187, - "name": "ColumnName" - } - }, - { - "id": 189, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 190, - "name": "likeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." - }, - "parameters": [ - { - "id": 191, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 192, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 366, - "name": "limit", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 96, - "character": 2 - } - ], - "signatures": [ - { - "id": 367, - "name": "limit", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by `count`." - }, - "parameters": [ - { - "id": 368, - "name": "count", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The maximum number of rows to return" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 369, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 370, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 371, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 96, - "character": 43 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [371] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 466, - "name": "default.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 465, - "name": "default.limit" - } - }, - { - "id": 153, - "name": "lt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 87, - "character": 2 - } - ], - "signatures": [ - { - "id": 154, - "name": "lt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is less than `value`." - }, - "typeParameter": [ - { - "id": 155, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 156, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 155, - "name": "ColumnName" - } - }, - { - "id": 157, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 155, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 158, - "name": "lt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is less than `value`." - }, - "parameters": [ - { - "id": 159, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 160, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 161, - "name": "lte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 100, - "character": 2 - } - ], - "signatures": [ - { - "id": 162, - "name": "lte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." - }, - "typeParameter": [ - { - "id": 163, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 164, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 163, - "name": "ColumnName" - } - }, - { - "id": 165, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 163, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 166, - "name": "lte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." - }, - "parameters": [ - { - "id": 167, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 168, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 313, - "name": "match", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 421, - "character": 2 - } - ], - "signatures": [ - { - "id": 314, - "name": "match", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." - }, - "typeParameter": [ - { - "id": 315, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 316, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 315, - "name": "ColumnName" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 315, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 317, - "name": "match", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." - }, - "parameters": [ - { - "id": 318, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 385, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 149, - "character": 2 - } - ], - "signatures": [ - { - "id": 386, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" - }, - "typeParameter": [ - { - "id": 387, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 119, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 387, - "name": "ResultOne" - } - ] - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 485, - "name": "default.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 484, - "name": "default.maybeSingle" - } - }, - { - "id": 129, - "name": "neq", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 130, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." - }, - "typeParameter": [ - { - "id": 131, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 132, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 131, - "name": "ColumnName" - } - }, - { - "id": 133, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 131, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 134, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." - }, - "parameters": [ - { - "id": 135, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 136, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 319, - "name": "not", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 437, - "character": 2 - } - ], - "signatures": [ - { - "id": 320, - "name": "not", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" - }, - "typeParameter": [ - { - "id": 321, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 322, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 321, - "name": "ColumnName" - } - }, - { - "id": 323, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" - }, - "type": { - "type": "reference", - "name": "FilterOperator" - } - }, - { - "id": 324, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 321, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 325, - "name": "not", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" - }, - "parameters": [ - { - "id": 326, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 327, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 328, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 329, - "name": "or", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 474, - "character": 2 - } - ], - "signatures": [ - { - "id": 330, - "name": "or", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which satisfy at least one of the filters.", - "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" - }, - "parameters": [ - { - "id": 331, - "name": "filters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The filters to use, following PostgREST syntax" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 332, - "name": "foreignTable", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Set this to filter on foreign tables instead of the\ncurrent table\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 333, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 334, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 474, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [334] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 350, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 44, - "character": 2 - } - ], - "signatures": [ - { - "id": 351, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" - }, - "typeParameter": [ - { - "id": 352, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 353, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 352, - "name": "ColumnName" - } - }, - { - "id": 354, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 355, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 356, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 46, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 358, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a foreign table by foreign\ncolumns\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 46, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 357, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 46, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [356, 358, 357] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 450, - "name": "default.order" - } - }, - { - "id": 359, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" - }, - "parameters": [ - { - "id": 360, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 361, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 362, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 363, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 50, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 365, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Set this to order a foreign table by foreign\ncolumns\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 50, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 364, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 50, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [363, 365, 364] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 458, - "name": "default.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 449, - "name": "default.order" - } - }, - { - "id": 289, - "name": "overlaps", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 360, - "character": 2 - } - ], - "signatures": [ - { - "id": 290, - "name": "overlaps", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." - }, - "typeParameter": [ - { - "id": 291, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 292, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The array or range column to filter on" - }, - "type": { - "type": "reference", - "id": 291, - "name": "ColumnName" - } - }, - { - "id": 293, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The array or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 291, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 118, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 294, - "name": "overlaps", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." - }, - "parameters": [ - { - "id": 295, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The array or range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 296, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The array or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 372, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by `from` and `to` inclusively." - }, - "parameters": [ - { - "id": 374, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The starting index from which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 375, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The last index to which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 376, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 377, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 378, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 54 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [378] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 472, - "name": "default.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 471, - "name": "default.range" - } - }, - { - "id": 281, - "name": "rangeAdjacent", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 345, - "character": 2 - } - ], - "signatures": [ - { - "id": 282, - "name": "rangeAdjacent", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." - }, - "typeParameter": [ - { - "id": 283, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 284, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 283, - "name": "ColumnName" - } - }, - { - "id": 285, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 286, - "name": "rangeAdjacent", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." - }, - "parameters": [ - { - "id": 287, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 288, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 249, - "name": "rangeGt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 287, - "character": 2 - } - ], - "signatures": [ - { - "id": 250, - "name": "rangeGt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." - }, - "typeParameter": [ - { - "id": 251, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 252, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 251, - "name": "ColumnName" - } - }, - { - "id": 253, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 254, - "name": "rangeGt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." - }, - "parameters": [ - { - "id": 255, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 256, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 257, - "name": "rangeGte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 301, - "character": 2 - } - ], - "signatures": [ - { - "id": 258, - "name": "rangeGte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." - }, - "typeParameter": [ - { - "id": 259, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 260, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 259, - "name": "ColumnName" - } - }, - { - "id": 261, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 262, - "name": "rangeGte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." - }, - "parameters": [ - { - "id": 263, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 264, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 265, - "name": "rangeLt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 316, - "character": 2 - } - ], - "signatures": [ - { - "id": 266, - "name": "rangeLt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." - }, - "typeParameter": [ - { - "id": 267, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 268, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 267, - "name": "ColumnName" - } - }, - { - "id": 269, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 270, - "name": "rangeLt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." - }, - "parameters": [ - { - "id": 271, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 273, - "name": "rangeLte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 330, - "character": 2 - } - ], - "signatures": [ - { - "id": 274, - "name": "rangeLte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." - }, - "typeParameter": [ - { - "id": 275, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 276, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 275, - "name": "ColumnName" - } - }, - { - "id": 277, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 278, - "name": "rangeLte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." - }, - "parameters": [ - { - "id": 279, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 280, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 404, - "name": "returns", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 246, - "character": 2 - } - ], - "signatures": [ - { - "id": 405, - "name": "returns", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Override the type of the returned `data`." - }, - "typeParameter": [ - { - "id": 406, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "The new result type to override with\n" - } - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "NewResult" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 504, - "name": "default.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 503, - "name": "default.returns" - } - }, - { - "id": 402, - "name": "rollback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 232, - "character": 2 - } - ], - "signatures": [ - { - "id": 403, - "name": "rollback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" - }, - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 502, - "name": "default.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 501, - "name": "default.rollback" - } - }, - { - "id": 345, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 19, - "character": 2 - } - ], - "signatures": [ - { - "id": 346, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" - }, - "typeParameter": [ - { - "id": 347, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 348, - "name": "NewResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 347, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 349, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The columns to retrieve, separated by commas\n" - }, - "type": { - "type": "reference", - "id": 347, - "name": "Query" - } - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 348, - "name": "NewResultOne" - } - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 445, - "name": "default.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 444, - "name": "default.select" - } - }, - { - "id": 382, - "name": "single", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 136, - "character": 2 - } - ], - "signatures": [ - { - "id": 383, - "name": "single", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" - }, - "typeParameter": [ - { - "id": 384, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 119, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "id": 384, - "name": "ResultOne" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 482, - "name": "default.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 481, - "name": "default.single" - } - }, - { - "id": 297, - "name": "textSearch", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 383, - "character": 2 - } - ], - "signatures": [ - { - "id": 298, - "name": "textSearch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." - }, - "typeParameter": [ - { - "id": 299, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 300, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The text or tsvector column to filter on" - }, - "type": { - "type": "reference", - "id": 299, - "name": "ColumnName" - } - }, - { - "id": 301, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The query text to match with" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 302, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 303, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 304, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The text search configuration to use" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 386, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 305, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Change how the `query` text is interpreted\n" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 386, - "character": 33 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [304, 305] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 306, - "name": "textSearch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." - }, - "parameters": [ - { - "id": 307, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The text or tsvector column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 308, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The query text to match with" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 309, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 310, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 311, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The text search configuration to use" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 391, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 312, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Change how the `query` text is interpreted\n" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 391, - "character": 33 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [311, 312] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 422, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 423, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 424, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 425, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 426, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 427, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 428, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 429, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 430, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 431, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 432, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 433, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 425, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 425, - "name": "TResult2" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - }, - { - "type": "reference", - "id": 425, - "name": "TResult2" - } - ] - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 522, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 521, - "name": "default.then" - } - }, - { - "id": 420, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 421, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" - }, - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 520, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 519, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [115] - }, - { - "title": "Properties", - "kind": 1024, - "children": [419, 411, 414, 409, 407, 410, 412, 413, 408] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 379, 241, 233, 388, 121, 392, 335, 390, 137, 145, 193, 201, 209, 225, 217, 169, 177, - 185, 366, 153, 161, 313, 385, 129, 319, 329, 350, 289, 372, 281, 249, 257, 265, 273, - 404, 402, 345, 382, 297, 422, 420 - ] - } - ], - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 28, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 434, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 435, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 436, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Schema" - }, - { - "type": "reference", - "id": 118, - "name": "Row" - }, - { - "type": "reference", - "id": 119, - "name": "Result" - } - ], - "name": "default" - } - ] - }, - { - "id": 49, - "name": "PostgrestQueryBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 50, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 16, - "character": 2 - } - ], - "signatures": [ - { - "id": 51, - "name": "new PostgrestQueryBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 52, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 53, - "name": "Relation", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "GenericTable" - }, - { - "type": "reference", - "name": "GenericView" - } - ] - } - } - ], - "parameters": [ - { - "id": 54, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - }, - { - "id": 55, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 59, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 60, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 61, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 62, - "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": 63, - "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": 57, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 23, - "character": 6 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 58, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 24, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [59, 57, 58] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "reference", - "id": 53, - "name": "Relation" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 68, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 70, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 71, - "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": 72, - "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": 65, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 66, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 67, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 13, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - }, - { - "id": 64, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - }, - { - "id": 107, - "name": "delete", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 319, - "character": 2 - } - ], - "signatures": [ - { - "id": 108, - "name": "delete", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a DELETE on the table or view.", - "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" - }, - "parameters": [ - { - "id": 109, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 110, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 111, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 322, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [111] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "literal", - "value": null - } - ], - "name": "default" - } - } - ] - }, - { - "id": 82, - "name": "insert", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 120, - "character": 2 - } - ], - "signatures": [ - { - "id": 83, - "name": "insert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, - "typeParameter": [ - { - "id": 84, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 85, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 84, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 84, - "name": "Row" - } - } - ] - } - }, - { - "id": 86, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 88, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 126, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 89, - "name": "defaultToNull", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 127, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [88, 89] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "literal", - "value": null - } - ], - "name": "default" - } - } - ] - }, - { - "id": 73, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 74, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a SELECT query on the table or view." - }, - "typeParameter": [ - { - "id": 75, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 76, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "reference", - "id": 75, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 77, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName`\n" - }, - "type": { - "type": "reference", - "id": 75, - "name": "Query" - } - }, - { - "id": 78, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 79, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 81, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 80, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [81, 80] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 76, - "name": "ResultOne" - } - } - ], - "name": "default" - } - } - ] - }, - { - "id": 100, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 271, - "character": 2 - } - ], - "signatures": [ - { - "id": 101, - "name": "update", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform an UPDATE on the table or view.", - "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" - }, - "typeParameter": [ - { - "id": 102, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 103, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to update with\n" - }, - "type": { - "type": "reference", - "id": 102, - "name": "Row" - } - }, - { - "id": 104, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 106, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 276, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [106] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "literal", - "value": null - } - ], - "name": "default" - } - } - ] - }, - { - "id": 90, - "name": "upsert", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 201, - "character": 2 - } - ], - "signatures": [ - { - "id": 91, - "name": "upsert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, - "typeParameter": [ - { - "id": 92, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 93, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 92, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 92, - "name": "Row" - } - } - ] - } - }, - { - "id": 94, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 95, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 98, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 211, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 99, - "name": "defaultToNull", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n`ignoreDuplicates: false`.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 212, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "ignoreDuplicates", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 210, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 96, - "name": "onConflict", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 209, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [98, 99, 97, 96] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 114, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "literal", - "value": null - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [50] - }, - { - "title": "Properties", - "kind": 1024, - "children": [68, 65, 66, 67, 64] - }, - { - "title": "Methods", - "kind": 2048, - "children": [107, 82, 73, 100, 90] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 6, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 112, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 113, - "name": "Relation", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "GenericTable" - }, - { - "type": "reference", - "name": "GenericView" - } - ] - } - } - ] - }, - { - "id": 437, - "name": "PostgrestTransformBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 438, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "signatures": [ - { - "id": 439, - "name": "new PostgrestTransformBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 440, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 441, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 442, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 443, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 538, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 537, - "name": "default.constructor" - } - }, - { - "id": 518, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 553, - "name": "default.allowEmpty" - } - }, - { - "id": 510, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "id": 545, - "name": "default.body" - } - }, - { - "id": 513, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 515, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 516, - "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": 517, - "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" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 548, - "name": "default.fetch" - } - }, - { - "id": 508, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "inheritedFrom": { - "type": "reference", - "id": 543, - "name": "default.headers" - } - }, - { - "id": 506, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 541, - "name": "default.method" - } - }, - { - "id": 509, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 544, - "name": "default.schema" - } - }, - { - "id": 511, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 546, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 512, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - }, - "inheritedFrom": { - "type": "reference", - "id": 547, - "name": "default.signal" - } - }, - { - "id": 507, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - }, - "inheritedFrom": { - "type": "reference", - "id": 542, - "name": "default.url" - } - }, - { - "id": 478, - "name": "abortSignal", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 125, - "character": 2 - } - ], - "signatures": [ - { - "id": 479, - "name": "abortSignal", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Set the AbortSignal for the fetch request." - }, - "parameters": [ - { - "id": 480, - "name": "signal", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" - }, - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 487, - "name": "csv", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, - "character": 2 - } - ], - "signatures": [ - { - "id": 488, - "name": "csv", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a string in CSV format." - }, - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 491, - "name": "explain", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 194, - "character": 2 - } - ], - "signatures": [ - { - "id": 492, - "name": "explain", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query." - }, - "parameters": [ - { - "id": 493, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 494, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 495, - "name": "analyze", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 202, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 498, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on buffer usage\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 500, - "name": "format", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 497, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 496, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 499, - "name": "wal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on WAL record generation\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [495, 498, 500, 497, 496, 499] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "default" - }, - { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "name": "default" - } - ] - } - } - ] - }, - { - "id": 489, - "name": "geojson", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, - "character": 2 - } - ], - "signatures": [ - { - "id": 490, - "name": "geojson", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." - }, - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 465, - "name": "limit", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 96, - "character": 2 - } - ], - "signatures": [ - { - "id": 466, - "name": "limit", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by `count`." - }, - "parameters": [ - { - "id": 467, - "name": "count", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The maximum number of rows to return" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 468, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 469, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 470, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 96, - "character": 43 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [470] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 484, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 149, - "character": 2 - } - ], - "signatures": [ - { - "id": 485, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" - }, - "typeParameter": [ - { - "id": 486, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 442, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 387, - "name": "ResultOne" - } - ] - } - ], - "name": "default" - } - } - ] - }, - { - "id": 449, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 44, - "character": 2 - } - ], - "signatures": [ - { - "id": 450, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" - }, - "typeParameter": [ - { - "id": 451, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 452, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 352, - "name": "ColumnName" - } - }, - { - "id": 453, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 455, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 46, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 457, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a foreign table by foreign\ncolumns\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 46, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 456, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 46, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [455, 457, 456] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 458, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" - }, - "parameters": [ - { - "id": 459, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 460, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 461, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 462, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 50, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 464, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Set this to order a foreign table by foreign\ncolumns\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 50, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 463, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 50, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [462, 464, 463] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 471, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2 - } - ], - "signatures": [ - { - "id": 472, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by `from` and `to` inclusively." - }, - "parameters": [ - { - "id": 473, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The starting index from which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 474, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The last index to which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 475, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 476, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 477, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 54 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [477] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 503, - "name": "returns", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 246, - "character": 2 - } - ], - "signatures": [ - { - "id": 504, - "name": "returns", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Override the type of the returned `data`." - }, - "typeParameter": [ - { - "id": 505, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "The new result type to override with\n" - } - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "NewResult" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 501, - "name": "rollback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 232, - "character": 2 - } - ], - "signatures": [ - { - "id": 502, - "name": "rollback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" - }, - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 444, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 19, - "character": 2 - } - ], - "signatures": [ - { - "id": 445, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" - }, - "typeParameter": [ - { - "id": 446, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 447, - "name": "NewResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 347, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 448, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The columns to retrieve, separated by commas\n" - }, - "type": { - "type": "reference", - "id": 347, - "name": "Query" - } - } - ], - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 348, - "name": "NewResultOne" - } - } - ], - "name": "default" - } - } - ] - }, - { - "id": 481, - "name": "single", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 136, - "character": 2 - } - ], - "signatures": [ - { - "id": 482, - "name": "single", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" - }, - "typeParameter": [ - { - "id": 483, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 442, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "id": 384, - "name": "ResultOne" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 521, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 522, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 523, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 524, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 525, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 526, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 527, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 528, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 529, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 530, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 531, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 532, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 425, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 425, - "name": "TResult2" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 424, - "name": "TResult1" - }, - { - "type": "reference", - "id": 425, - "name": "TResult2" - } - ] - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 557, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 556, - "name": "default.then" - } - }, - { - "id": 519, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 520, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" - }, - "type": { - "type": "reference", - "id": 437, - "typeArguments": [ - { - "type": "reference", - "id": 440, - "name": "Schema" - }, - { - "type": "reference", - "id": 441, - "name": "Row" - }, - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 555, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 554, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [438] - }, - { - "title": "Properties", - "kind": 1024, - "children": [518, 510, 513, 508, 506, 509, 511, 512, 507] - }, - { - "title": "Methods", - "kind": 2048, - "children": [478, 487, 491, 489, 465, 484, 449, 471, 503, 501, 444, 481, 521, 519] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 5, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 533, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 534, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 535, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 536, - "typeArguments": [ - { - "type": "reference", - "id": 442, - "name": "Result" - } - ], - "name": "default" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 114, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 571, - "name": "PostgrestResponseFailure", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 574, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 573, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 572, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 588, - "name": "PostgrestError" - } - }, - { - "id": 575, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 576, - "name": "statusText", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.statusText" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [574, 573, 572, 575, 576] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 29, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "name": "PostgrestResponseBase" - } - ] - }, - { - "id": 577, - "name": "PostgrestResponseSuccess", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 580, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 27, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 579, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 26, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 583, - "name": "T" - } - }, - { - "id": 578, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 581, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 582, - "name": "statusText", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.statusText" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [580, 579, 578, 581, 582] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 24, - "character": 17 - } - ], - "typeParameter": [ - { - "id": 583, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "name": "PostgrestResponseBase" - } - ] - }, - { - "id": 588, - "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 589, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 593, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 591, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 592, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 590, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [593, 591, 592, 590] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 29 - } - ] - } - } - }, - { - "id": 586, - "name": "PostgrestMaybeSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 39, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 587, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 587, - "name": "T" - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 569, - "name": "PostgrestResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 40, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 570, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reference", - "id": 584, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 570, - "name": "T" - } - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 584, - "name": "PostgrestSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 38, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 585, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 577, - "typeArguments": [ - { - "type": "reference", - "id": 585, - "name": "T" - } - ], - "name": "PostgrestResponseSuccess" - }, - { - "type": "reference", - "id": 571, - "name": "PostgrestResponseFailure" - } - ] - } - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [536, 1, 114, 49, 437] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [571, 577] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [588, 586, 569, 584] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] -} + "id": 0, + "name": "@supabase/postgrest-js", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 536, + "name": "PostgrestBuilder", + "kind": 128, + "kindString": "Class", + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 537, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 2 + } + ], + "signatures": [ + { + "id": 538, + "name": "new PostgrestBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 539, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "parameters": [ + { + "id": 540, + "name": "builder", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "id": 539, + "name": "Result" + } + ], + "name": "default" + } + } + ], + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "id": 539, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 545, + "name": "body", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 12, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 548, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 15, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 549, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 550, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 551, + "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": 552, + "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": 543, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 10, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 553, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 541, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + } + }, + { + "id": 544, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 11, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 546, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 13, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 547, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + }, + { + "id": 542, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 9, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + }, + { + "id": 556, + "name": "then", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 48, + "character": 2 + } + ], + "signatures": [ + { + "id": 557, + "name": "then", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 558, + "name": "TResult1", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "reference", + "id": 539, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 559, + "name": "TResult2", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "never" + } + } + ], + "parameters": [ + { + "id": 560, + "name": "onfulfilled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 561, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 562, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 563, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "reference", + "id": 539, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 564, + "name": "onrejected", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 565, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 566, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 567, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 425, + "name": "TResult2" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 425, + "name": "TResult2" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + }, + { + "type": "reference", + "id": 425, + "name": "TResult2" + } + ] + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "implementationOf": { + "type": "reference", + "name": "PromiseLike.then" + } + } + ], + "implementationOf": { + "type": "reference", + "name": "PromiseLike.then" + } + }, + { + "id": 554, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 555, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", + "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + }, + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "id": 539, + "name": "Result" + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 537 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 556, + 554 + ] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 5, + "character": 30 + } + ], + "typeParameter": [ + { + "id": 568, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 437, + "name": "PostgrestTransformBuilder" + } + ], + "implementedTypes": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "reference", + "id": 539, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + }, + { + "id": 1, + "name": "PostgrestClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "PostgREST client." + }, + "children": [ + { + "id": 2, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 41, + "character": 2 + } + ], + "signatures": [ + { + "id": 3, + "name": "new PostgrestClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Creates a PostgREST client." + }, + "typeParameter": [ + { + "id": 4, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 6, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "parameters": [ + { + "id": 7, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "URL of the PostgREST endpoint" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 8, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 9, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 12, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 50, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 13, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 14, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Custom fetch\n" + }, + "parameters": [ + { + "id": 15, + "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": 16, + "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": 10, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Custom headers" + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 48, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 11, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Postgres schema to switch to" + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 49, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 5, + "name": "SchemaName" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 12, + 10, + 11 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 1, + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 6, + "name": "Schema" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 20, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 21, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 22, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 23, + "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": 24, + "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": 18, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 27, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 19, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 28, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 5, + "name": "SchemaName" + } + }, + { + "id": 17, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 26, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 25, + "name": "from", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 59, + "character": 2 + } + ], + "signatures": [ + { + "id": 26, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "typeParameter": [ + { + "id": 27, + "name": "TableName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 28, + "name": "Table", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericTable" + } + } + ], + "parameters": [ + { + "id": 29, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "reference", + "id": 27, + "name": "TableName" + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 6, + "name": "Schema" + }, + { + "type": "reference", + "id": 28, + "name": "Table" + } + ], + "name": "default" + } + }, + { + "id": 30, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "typeParameter": [ + { + "id": 31, + "name": "ViewName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 32, + "name": "View", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericView" + } + } + ], + "parameters": [ + { + "id": 33, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "reference", + "id": 31, + "name": "ViewName" + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 6, + "name": "Schema" + }, + { + "type": "reference", + "id": 32, + "name": "View" + } + ], + "name": "default" + } + }, + { + "id": 34, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "parameters": [ + { + "id": 35, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 6, + "name": "Schema" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 36, + "name": "rpc", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 102, + "character": 2 + } + ], + "signatures": [ + { + "id": 37, + "name": "rpc", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a function call." + }, + "typeParameter": [ + { + "id": 38, + "name": "FunctionName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 39, + "name": "Function_", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericFunction" + } + } + ], + "parameters": [ + { + "id": 40, + "name": "fn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The function name to call" + }, + "type": { + "type": "reference", + "id": 38, + "name": "FunctionName" + } + }, + { + "id": 41, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The arguments to pass to the function call" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Args" + }, + "objectType": { + "type": "reference", + "id": 39, + "name": "Function_" + } + }, + "defaultValue": "{}" + }, + { + "id": 42, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 43, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 45, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 113, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 44, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 112, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 45, + 44 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 6, + "name": "Schema" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 39, + "name": "Function_" + } + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "number" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + } + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 39, + "name": "Function_" + } + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 2 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 20, + 18, + 19, + 17 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 25, + 36 + ] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 17, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 46, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" + }, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 47, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 48, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ] + }, + { + "id": 114, + "name": "PostgrestFilterBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 115, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 116, + "name": "new PostgrestFilterBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 117, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 118, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 119, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "parameters": [ + { + "id": 120, + "name": "builder", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 439, + "name": "default.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 438, + "name": "default.constructor" + } + }, + { + "id": 411, + "name": "body", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 12, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "inheritedFrom": { + "type": "reference", + "id": 510, + "name": "default.body" + } + }, + { + "id": 414, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 15, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 415, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 416, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 417, + "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": 418, + "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" + } + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 513, + "name": "default.fetch" + } + }, + { + "id": 409, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 10, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "inheritedFrom": { + "type": "reference", + "id": 508, + "name": "default.headers" + } + }, + { + "id": 419, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 518, + "name": "default.isMaybeSingle" + } + }, + { + "id": 407, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 506, + "name": "default.method" + } + }, + { + "id": 410, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 11, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 509, + "name": "default.schema" + } + }, + { + "id": 412, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 13, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 511, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 413, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + }, + "inheritedFrom": { + "type": "reference", + "id": 512, + "name": "default.signal" + } + }, + { + "id": 408, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 9, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + }, + "inheritedFrom": { + "type": "reference", + "id": 507, + "name": "default.url" + } + }, + { + "id": 379, + "name": "abortSignal", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 125, + "character": 2 + } + ], + "signatures": [ + { + "id": 380, + "name": "abortSignal", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set the AbortSignal for the fetch request." + }, + "parameters": [ + { + "id": 381, + "name": "signal", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 479, + "name": "default.abortSignal" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 478, + "name": "default.abortSignal" + } + }, + { + "id": 241, + "name": "containedBy", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 261, + "character": 2 + } + ], + "signatures": [ + { + "id": 242, + "name": "containedBy", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + }, + "typeParameter": [ + { + "id": 243, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 244, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range column to filter on" + }, + "type": { + "type": "reference", + "id": 243, + "name": "ColumnName" + } + }, + { + "id": 245, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 243, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 246, + "name": "containedBy", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + }, + "parameters": [ + { + "id": 247, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 248, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 233, + "name": "contains", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 234, + "character": 2 + } + ], + "signatures": [ + { + "id": 234, + "name": "contains", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + }, + "typeParameter": [ + { + "id": 235, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 236, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range column to filter on" + }, + "type": { + "type": "reference", + "id": 235, + "name": "ColumnName" + } + }, + { + "id": 237, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 235, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 238, + "name": "contains", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + }, + "parameters": [ + { + "id": 239, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 240, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 388, + "name": "csv", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 166, + "character": 2 + } + ], + "signatures": [ + { + "id": 389, + "name": "csv", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a string in CSV format." + }, + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 488, + "name": "default.csv" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 487, + "name": "default.csv" + } + }, + { + "id": 121, + "name": "eq", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 33, + "character": 2 + } + ], + "signatures": [ + { + "id": 122, + "name": "eq", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is equal to `value`.", + "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" + }, + "typeParameter": [ + { + "id": 123, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 124, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 123, + "name": "ColumnName" + } + }, + { + "id": 125, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 123, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 126, + "name": "eq", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is equal to `value`.", + "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" + }, + "parameters": [ + { + "id": 127, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 128, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 392, + "name": "explain", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 200, + "character": 2 + } + ], + "signatures": [ + { + "id": 393, + "name": "explain", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as the EXPLAIN plan for the query." + }, + "parameters": [ + { + "id": 394, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 395, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 396, + "name": "analyze", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 208, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 399, + "name": "buffers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on buffer usage\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 211, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 401, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 213, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 398, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 210, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 397, + "name": "verbose", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 209, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 400, + "name": "wal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 212, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 396, + 399, + 401, + 398, + 397, + 400 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "name": "default" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 492, + "name": "default.explain" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 491, + "name": "default.explain" + } + }, + { + "id": 335, + "name": "filter", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 480, + "character": 2 + } + ], + "signatures": [ + { + "id": 336, + "name": "filter", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + }, + "typeParameter": [ + { + "id": 337, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 338, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 337, + "name": "ColumnName" + } + }, + { + "id": 339, + "name": "operator", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The operator to filter with, following PostgREST syntax" + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "FilterOperator" + }, + { + "type": "literal", + "value": "not.eq" + }, + { + "type": "literal", + "value": "not.neq" + }, + { + "type": "literal", + "value": "not.gt" + }, + { + "type": "literal", + "value": "not.gte" + }, + { + "type": "literal", + "value": "not.lt" + }, + { + "type": "literal", + "value": "not.lte" + }, + { + "type": "literal", + "value": "not.like" + }, + { + "type": "literal", + "value": "not.ilike" + }, + { + "type": "literal", + "value": "not.is" + }, + { + "type": "literal", + "value": "not.in" + }, + { + "type": "literal", + "value": "not.cs" + }, + { + "type": "literal", + "value": "not.cd" + }, + { + "type": "literal", + "value": "not.sl" + }, + { + "type": "literal", + "value": "not.sr" + }, + { + "type": "literal", + "value": "not.nxl" + }, + { + "type": "literal", + "value": "not.nxr" + }, + { + "type": "literal", + "value": "not.adj" + }, + { + "type": "literal", + "value": "not.ov" + }, + { + "type": "literal", + "value": "not.fts" + }, + { + "type": "literal", + "value": "not.plfts" + }, + { + "type": "literal", + "value": "not.phfts" + }, + { + "type": "literal", + "value": "not.wfts" + } + ] + } + }, + { + "id": 340, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with, following PostgREST syntax\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 341, + "name": "filter", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + }, + "parameters": [ + { + "id": 342, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 343, + "name": "operator", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The operator to filter with, following PostgREST syntax" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 344, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with, following PostgREST syntax\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 390, + "name": "geojson", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 174, + "character": 2 + } + ], + "signatures": [ + { + "id": 391, + "name": "geojson", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + }, + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 490, + "name": "default.geojson" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 489, + "name": "default.geojson" + } + }, + { + "id": 137, + "name": "gt", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 61, + "character": 2 + } + ], + "signatures": [ + { + "id": 138, + "name": "gt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is greater than `value`." + }, + "typeParameter": [ + { + "id": 139, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 140, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 139, + "name": "ColumnName" + } + }, + { + "id": 141, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 139, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 142, + "name": "gt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is greater than `value`." + }, + "parameters": [ + { + "id": 143, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 144, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 145, + "name": "gte", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 74, + "character": 2 + } + ], + "signatures": [ + { + "id": 146, + "name": "gte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is greater than or equal to `value`." + }, + "typeParameter": [ + { + "id": 147, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 148, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 147, + "name": "ColumnName" + } + }, + { + "id": 149, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 147, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 150, + "name": "gte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is greater than or equal to `value`." + }, + "parameters": [ + { + "id": 151, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 152, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 193, + "name": "ilike", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 152, + "character": 2 + } + ], + "signatures": [ + { + "id": 194, + "name": "ilike", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches `pattern` case-insensitively." + }, + "typeParameter": [ + { + "id": 195, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 196, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 195, + "name": "ColumnName" + } + }, + { + "id": 197, + "name": "pattern", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The pattern to match with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 198, + "name": "ilike", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches `pattern` case-insensitively." + }, + "parameters": [ + { + "id": 199, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 200, + "name": "pattern", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The pattern to match with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 201, + "name": "ilikeAllOf", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 165, + "character": 2 + } + ], + "signatures": [ + { + "id": 202, + "name": "ilikeAllOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." + }, + "typeParameter": [ + { + "id": 203, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 204, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 203, + "name": "ColumnName" + } + }, + { + "id": 205, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 206, + "name": "ilikeAllOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." + }, + "parameters": [ + { + "id": 207, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 208, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 209, + "name": "ilikeAnyOf", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 178, + "character": 2 + } + ], + "signatures": [ + { + "id": 210, + "name": "ilikeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + }, + "typeParameter": [ + { + "id": 211, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 212, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 211, + "name": "ColumnName" + } + }, + { + "id": 213, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 214, + "name": "ilikeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + }, + "parameters": [ + { + "id": 215, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 216, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 225, + "name": "in", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 213, + "character": 2 + } + ], + "signatures": [ + { + "id": 226, + "name": "in", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is included in the `values` array." + }, + "typeParameter": [ + { + "id": 227, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 228, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 227, + "name": "ColumnName" + } + }, + { + "id": 229, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values array to filter with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 227, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 230, + "name": "in", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is included in the `values` array." + }, + "parameters": [ + { + "id": 231, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 232, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values array to filter with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 217, + "name": "is", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 191, + "character": 2 + } + ], + "signatures": [ + { + "id": 218, + "name": "is", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` IS `value`.", + "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + }, + "typeParameter": [ + { + "id": 219, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 220, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 219, + "name": "ColumnName" + } + }, + { + "id": 221, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "intersection", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 219, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + }, + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "intersection", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 219, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + }, + { + "type": "literal", + "value": false + } + ] + }, + { + "type": "intersection", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 219, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + }, + { + "type": "literal", + "value": true + } + ] + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 222, + "name": "is", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` IS `value`.", + "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + }, + "parameters": [ + { + "id": 223, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 224, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 169, + "name": "like", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 113, + "character": 2 + } + ], + "signatures": [ + { + "id": 170, + "name": "like", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + }, + "typeParameter": [ + { + "id": 171, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 172, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 171, + "name": "ColumnName" + } + }, + { + "id": 173, + "name": "pattern", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The pattern to match with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 174, + "name": "like", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + }, + "parameters": [ + { + "id": 175, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 176, + "name": "pattern", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The pattern to match with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 177, + "name": "likeAllOf", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 126, + "character": 2 + } + ], + "signatures": [ + { + "id": 178, + "name": "likeAllOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." + }, + "typeParameter": [ + { + "id": 179, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 180, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 179, + "name": "ColumnName" + } + }, + { + "id": 181, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 182, + "name": "likeAllOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." + }, + "parameters": [ + { + "id": 183, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 184, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 185, + "name": "likeAnyOf", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 139, + "character": 2 + } + ], + "signatures": [ + { + "id": 186, + "name": "likeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." + }, + "typeParameter": [ + { + "id": 187, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 188, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 187, + "name": "ColumnName" + } + }, + { + "id": 189, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 190, + "name": "likeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." + }, + "parameters": [ + { + "id": 191, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 192, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 366, + "name": "limit", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 96, + "character": 2 + } + ], + "signatures": [ + { + "id": 367, + "name": "limit", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by `count`." + }, + "parameters": [ + { + "id": 368, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The maximum number of rows to return" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 369, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 370, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 371, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 96, + "character": 43 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 371 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 466, + "name": "default.limit" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 465, + "name": "default.limit" + } + }, + { + "id": 153, + "name": "lt", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 87, + "character": 2 + } + ], + "signatures": [ + { + "id": 154, + "name": "lt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is less than `value`." + }, + "typeParameter": [ + { + "id": 155, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 156, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 155, + "name": "ColumnName" + } + }, + { + "id": 157, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 155, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 158, + "name": "lt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is less than `value`." + }, + "parameters": [ + { + "id": 159, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 160, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 161, + "name": "lte", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 100, + "character": 2 + } + ], + "signatures": [ + { + "id": 162, + "name": "lte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is less than or equal to `value`." + }, + "typeParameter": [ + { + "id": 163, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 164, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 163, + "name": "ColumnName" + } + }, + { + "id": 165, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 163, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 166, + "name": "lte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is less than or equal to `value`." + }, + "parameters": [ + { + "id": 167, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 168, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 313, + "name": "match", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 421, + "character": 2 + } + ], + "signatures": [ + { + "id": 314, + "name": "match", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + }, + "typeParameter": [ + { + "id": 315, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 316, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 315, + "name": "ColumnName" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 315, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 317, + "name": "match", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + }, + "parameters": [ + { + "id": 318, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 385, + "name": "maybeSingle", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 149, + "character": 2 + } + ], + "signatures": [ + { + "id": 386, + "name": "maybeSingle", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + }, + "typeParameter": [ + { + "id": 387, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 119, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 387, + "name": "ResultOne" + } + ] + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 485, + "name": "default.maybeSingle" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 484, + "name": "default.maybeSingle" + } + }, + { + "id": 129, + "name": "neq", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 48, + "character": 2 + } + ], + "signatures": [ + { + "id": 130, + "name": "neq", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is not equal to `value`." + }, + "typeParameter": [ + { + "id": 131, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 132, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 131, + "name": "ColumnName" + } + }, + { + "id": 133, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 131, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 134, + "name": "neq", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is not equal to `value`." + }, + "parameters": [ + { + "id": 135, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 136, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 319, + "name": "not", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 437, + "character": 2 + } + ], + "signatures": [ + { + "id": 320, + "name": "not", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which doesn't satisfy the filter.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + }, + "typeParameter": [ + { + "id": 321, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 322, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 321, + "name": "ColumnName" + } + }, + { + "id": 323, + "name": "operator", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + }, + "type": { + "type": "reference", + "name": "FilterOperator" + } + }, + { + "id": 324, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with, following PostgREST syntax\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 321, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 325, + "name": "not", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which doesn't satisfy the filter.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + }, + "parameters": [ + { + "id": 326, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 327, + "name": "operator", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 328, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with, following PostgREST syntax\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 329, + "name": "or", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 474, + "character": 2 + } + ], + "signatures": [ + { + "id": 330, + "name": "or", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which satisfy at least one of the filters.", + "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" + }, + "parameters": [ + { + "id": 331, + "name": "filters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The filters to use, following PostgREST syntax" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 332, + "name": "foreignTable", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Set this to filter on foreign tables instead of the\ncurrent table\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 333, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 334, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 474, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 334 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 350, + "name": "order", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 44, + "character": 2 + } + ], + "signatures": [ + { + "id": 351, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" + }, + "typeParameter": [ + { + "id": 352, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 353, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 352, + "name": "ColumnName" + } + }, + { + "id": 354, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 355, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 356, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 46, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 358, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 46, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + }, + { + "id": 357, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 46, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 356, + 358, + 357 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 450, + "name": "default.order" + } + }, + { + "id": 359, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" + }, + "parameters": [ + { + "id": 360, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 361, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 362, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 363, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 50, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 365, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 50, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 364, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 50, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 363, + 365, + 364 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 458, + "name": "default.order" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 449, + "name": "default.order" + } + }, + { + "id": 289, + "name": "overlaps", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 360, + "character": 2 + } + ], + "signatures": [ + { + "id": 290, + "name": "overlaps", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + }, + "typeParameter": [ + { + "id": 291, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 292, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The array or range column to filter on" + }, + "type": { + "type": "reference", + "id": 291, + "name": "ColumnName" + } + }, + { + "id": 293, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The array or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 291, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 294, + "name": "overlaps", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + }, + "parameters": [ + { + "id": 295, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The array or range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 296, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The array or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 372, + "name": "range", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 111, + "character": 2 + } + ], + "signatures": [ + { + "id": 373, + "name": "range", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by `from` and `to` inclusively." + }, + "parameters": [ + { + "id": 374, + "name": "from", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 375, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 376, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 377, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 378, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 111, + "character": 54 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 378 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 472, + "name": "default.range" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 471, + "name": "default.range" + } + }, + { + "id": 281, + "name": "rangeAdjacent", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 345, + "character": 2 + } + ], + "signatures": [ + { + "id": 282, + "name": "rangeAdjacent", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + }, + "typeParameter": [ + { + "id": 283, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 284, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 283, + "name": "ColumnName" + } + }, + { + "id": 285, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 286, + "name": "rangeAdjacent", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + }, + "parameters": [ + { + "id": 287, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 288, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 249, + "name": "rangeGt", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 287, + "character": 2 + } + ], + "signatures": [ + { + "id": 250, + "name": "rangeGt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + }, + "typeParameter": [ + { + "id": 251, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 252, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 251, + "name": "ColumnName" + } + }, + { + "id": 253, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 254, + "name": "rangeGt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + }, + "parameters": [ + { + "id": 255, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 256, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 257, + "name": "rangeGte", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 301, + "character": 2 + } + ], + "signatures": [ + { + "id": 258, + "name": "rangeGte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + }, + "typeParameter": [ + { + "id": 259, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 260, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 259, + "name": "ColumnName" + } + }, + { + "id": 261, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 262, + "name": "rangeGte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + }, + "parameters": [ + { + "id": 263, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 264, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 265, + "name": "rangeLt", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 316, + "character": 2 + } + ], + "signatures": [ + { + "id": 266, + "name": "rangeLt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + }, + "typeParameter": [ + { + "id": 267, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 268, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 267, + "name": "ColumnName" + } + }, + { + "id": 269, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 270, + "name": "rangeLt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + }, + "parameters": [ + { + "id": 271, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 272, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 273, + "name": "rangeLte", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 330, + "character": 2 + } + ], + "signatures": [ + { + "id": 274, + "name": "rangeLte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + }, + "typeParameter": [ + { + "id": 275, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 276, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 275, + "name": "ColumnName" + } + }, + { + "id": 277, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 278, + "name": "rangeLte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + }, + "parameters": [ + { + "id": 279, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 280, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 404, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 252, + "character": 2 + } + ], + "signatures": [ + { + "id": 405, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`." + }, + "typeParameter": [ + { + "id": 406, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with\n" + } + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "NewResult" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 504, + "name": "default.returns" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 503, + "name": "default.returns" + } + }, + { + "id": 402, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 238, + "character": 2 + } + ], + "signatures": [ + { + "id": 403, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 502, + "name": "default.rollback" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 501, + "name": "default.rollback" + } + }, + { + "id": 345, + "name": "select", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 19, + "character": 2 + } + ], + "signatures": [ + { + "id": 346, + "name": "select", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + }, + "typeParameter": [ + { + "id": 347, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 348, + "name": "NewResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 347, + "name": "Query" + } + ], + "name": "GetResult" + } + } + ], + "parameters": [ + { + "id": 349, + "name": "columns", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The columns to retrieve, separated by commas\n" + }, + "type": { + "type": "reference", + "id": 347, + "name": "Query" + } + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "id": 348, + "name": "NewResultOne" + } + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 445, + "name": "default.select" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 444, + "name": "default.select" + } + }, + { + "id": 382, + "name": "single", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 136, + "character": 2 + } + ], + "signatures": [ + { + "id": 383, + "name": "single", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" + }, + "typeParameter": [ + { + "id": 384, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 119, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "id": 384, + "name": "ResultOne" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 482, + "name": "default.single" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 481, + "name": "default.single" + } + }, + { + "id": 297, + "name": "textSearch", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 383, + "character": 2 + } + ], + "signatures": [ + { + "id": 298, + "name": "textSearch", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." + }, + "typeParameter": [ + { + "id": 299, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 300, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The text or tsvector column to filter on" + }, + "type": { + "type": "reference", + "id": 299, + "name": "ColumnName" + } + }, + { + "id": 301, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The query text to match with" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 302, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 303, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 304, + "name": "config", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The text search configuration to use" + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 386, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 305, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Change how the `query` text is interpreted\n" + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 386, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "plain" + }, + { + "type": "literal", + "value": "phrase" + }, + { + "type": "literal", + "value": "websearch" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 304, + 305 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 306, + "name": "textSearch", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." + }, + "parameters": [ + { + "id": 307, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The text or tsvector column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 308, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The query text to match with" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 309, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 310, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 311, + "name": "config", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The text search configuration to use" + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 391, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 312, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Change how the `query` text is interpreted\n" + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 391, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "plain" + }, + { + "type": "literal", + "value": "phrase" + }, + { + "type": "literal", + "value": "websearch" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 311, + 312 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 422, + "name": "then", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 48, + "character": 2 + } + ], + "signatures": [ + { + "id": 423, + "name": "then", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 424, + "name": "TResult1", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 425, + "name": "TResult2", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "never" + } + } + ], + "parameters": [ + { + "id": 426, + "name": "onfulfilled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 427, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 428, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 429, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 430, + "name": "onrejected", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 431, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 432, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 433, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 425, + "name": "TResult2" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 425, + "name": "TResult2" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + }, + { + "type": "reference", + "id": 425, + "name": "TResult2" + } + ] + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "inheritedFrom": { + "type": "reference", + "id": 522, + "name": "default.then" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 521, + "name": "default.then" + } + }, + { + "id": 420, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 421, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", + "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + }, + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 520, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 519, + "name": "default.throwOnError" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 115 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 411, + 414, + 409, + 419, + 407, + 410, + 412, + 413, + 408 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 379, + 241, + 233, + 388, + 121, + 392, + 335, + 390, + 137, + 145, + 193, + 201, + 209, + 225, + 217, + 169, + 177, + 185, + 366, + 153, + 161, + 313, + 385, + 129, + 319, + 329, + 350, + 289, + 372, + 281, + 249, + 257, + 265, + 273, + 404, + 402, + 345, + 382, + 297, + 422, + 420 + ] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 28, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 434, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 435, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 436, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Schema" + }, + { + "type": "reference", + "id": 118, + "name": "Row" + }, + { + "type": "reference", + "id": 119, + "name": "Result" + } + ], + "name": "default" + } + ] + }, + { + "id": 49, + "name": "PostgrestQueryBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 50, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 16, + "character": 2 + } + ], + "signatures": [ + { + "id": 51, + "name": "new PostgrestQueryBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 52, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 53, + "name": "Relation", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] + } + } + ], + "parameters": [ + { + "id": 54, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + }, + { + "id": 55, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 56, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 59, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 25, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 60, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 61, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 62, + "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": 63, + "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": 57, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 23, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 58, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 24, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 59, + 57, + 58 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "reference", + "id": 53, + "name": "Relation" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 68, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 69, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 70, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 71, + "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": 72, + "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": 65, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 66, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 12, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 67, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 13, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + }, + { + "id": 64, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + }, + { + "id": 107, + "name": "delete", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 319, + "character": 2 + } + ], + "signatures": [ + { + "id": 108, + "name": "delete", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a DELETE on the table or view.", + "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + }, + "parameters": [ + { + "id": 109, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 110, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 111, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 322, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 111 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null + } + ], + "name": "default" + } + } + ] + }, + { + "id": 82, + "name": "insert", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 120, + "character": 2 + } + ], + "signatures": [ + { + "id": 83, + "name": "insert", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform an INSERT into the table or view.", + "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + }, + "typeParameter": [ + { + "id": 84, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 85, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 84, + "name": "Row" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "id": 84, + "name": "Row" + } + } + ] + } + }, + { + "id": 86, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 87, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 88, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 126, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 89, + "name": "defaultToNull", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 127, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 88, + 89 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null + } + ], + "name": "default" + } + } + ] + }, + { + "id": 73, + "name": "select", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 74, + "name": "select", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a SELECT query on the table or view." + }, + "typeParameter": [ + { + "id": 75, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 76, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "reference", + "id": 75, + "name": "Query" + } + ], + "name": "GetResult" + } + } + ], + "parameters": [ + { + "id": 77, + "name": "columns", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName`\n" + }, + "type": { + "type": "reference", + "id": 75, + "name": "Query" + } + }, + { + "id": 78, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 79, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 81, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 62, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 80, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 61, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 81, + 80 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "array", + "elementType": { + "type": "reference", + "id": 76, + "name": "ResultOne" + } + } + ], + "name": "default" + } + } + ] + }, + { + "id": 100, + "name": "update", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 271, + "character": 2 + } + ], + "signatures": [ + { + "id": 101, + "name": "update", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform an UPDATE on the table or view.", + "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + }, + "typeParameter": [ + { + "id": 102, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 103, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to update with\n" + }, + "type": { + "type": "reference", + "id": 102, + "name": "Row" + } + }, + { + "id": 104, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 105, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 106, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 276, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 106 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null + } + ], + "name": "default" + } + } + ] + }, + { + "id": 90, + "name": "upsert", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 201, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "upsert", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", + "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + }, + "typeParameter": [ + { + "id": 92, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 93, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 92, + "name": "Row" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "id": 92, + "name": "Row" + } + } + ] + } + }, + { + "id": 94, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 95, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 98, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 211, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 99, + "name": "defaultToNull", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n`ignoreDuplicates: false`.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 212, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 97, + "name": "ignoreDuplicates", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 210, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 96, + "name": "onConflict", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 209, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 98, + 99, + 97, + 96 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 114, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 50 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 68, + 65, + 66, + 67, + 64 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 107, + 82, + 73, + 100, + 90 + ] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 6, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 112, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 113, + "name": "Relation", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] + } + } + ] + }, + { + "id": 437, + "name": "PostgrestTransformBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 438, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 439, + "name": "new PostgrestTransformBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 440, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 441, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 442, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "parameters": [ + { + "id": 443, + "name": "builder", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + } + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 538, + "name": "default.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 537, + "name": "default.constructor" + } + }, + { + "id": 510, + "name": "body", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 12, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "inheritedFrom": { + "type": "reference", + "id": 545, + "name": "default.body" + } + }, + { + "id": 513, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 15, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 514, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 515, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 516, + "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": 517, + "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" + } + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 548, + "name": "default.fetch" + } + }, + { + "id": 508, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 10, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "inheritedFrom": { + "type": "reference", + "id": 543, + "name": "default.headers" + } + }, + { + "id": 518, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 553, + "name": "default.isMaybeSingle" + } + }, + { + "id": 506, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 541, + "name": "default.method" + } + }, + { + "id": 509, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 11, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 544, + "name": "default.schema" + } + }, + { + "id": 511, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 13, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 546, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 512, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + }, + "inheritedFrom": { + "type": "reference", + "id": 547, + "name": "default.signal" + } + }, + { + "id": 507, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 9, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + }, + "inheritedFrom": { + "type": "reference", + "id": 542, + "name": "default.url" + } + }, + { + "id": 478, + "name": "abortSignal", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 125, + "character": 2 + } + ], + "signatures": [ + { + "id": 479, + "name": "abortSignal", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set the AbortSignal for the fetch request." + }, + "parameters": [ + { + "id": 480, + "name": "signal", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 487, + "name": "csv", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 166, + "character": 2 + } + ], + "signatures": [ + { + "id": 488, + "name": "csv", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a string in CSV format." + }, + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 491, + "name": "explain", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 200, + "character": 2 + } + ], + "signatures": [ + { + "id": 492, + "name": "explain", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as the EXPLAIN plan for the query." + }, + "parameters": [ + { + "id": 493, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 494, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 495, + "name": "analyze", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 208, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 498, + "name": "buffers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on buffer usage\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 211, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 500, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 213, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 497, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 210, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 496, + "name": "verbose", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 209, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 499, + "name": "wal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 212, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 495, + 498, + 500, + 497, + 496, + 499 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "name": "default" + } + ] + } + } + ] + }, + { + "id": 489, + "name": "geojson", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 174, + "character": 2 + } + ], + "signatures": [ + { + "id": 490, + "name": "geojson", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + }, + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 465, + "name": "limit", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 96, + "character": 2 + } + ], + "signatures": [ + { + "id": 466, + "name": "limit", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by `count`." + }, + "parameters": [ + { + "id": 467, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The maximum number of rows to return" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 468, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 469, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 470, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 96, + "character": 43 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 470 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 484, + "name": "maybeSingle", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 149, + "character": 2 + } + ], + "signatures": [ + { + "id": 485, + "name": "maybeSingle", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + }, + "typeParameter": [ + { + "id": 486, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 442, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 387, + "name": "ResultOne" + } + ] + } + ], + "name": "default" + } + } + ] + }, + { + "id": 449, + "name": "order", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 44, + "character": 2 + } + ], + "signatures": [ + { + "id": 450, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" + }, + "typeParameter": [ + { + "id": 451, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 452, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 352, + "name": "ColumnName" + } + }, + { + "id": 453, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 454, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 455, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 46, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 457, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 46, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + }, + { + "id": 456, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 46, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 455, + 457, + 456 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 458, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" + }, + "parameters": [ + { + "id": 459, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 460, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 461, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 462, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 50, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 464, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 50, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 463, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 50, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 462, + 464, + 463 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 471, + "name": "range", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 111, + "character": 2 + } + ], + "signatures": [ + { + "id": 472, + "name": "range", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by `from` and `to` inclusively." + }, + "parameters": [ + { + "id": 473, + "name": "from", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 474, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 475, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 476, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 477, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 111, + "character": 54 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 477 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 503, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 252, + "character": 2 + } + ], + "signatures": [ + { + "id": 504, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`." + }, + "typeParameter": [ + { + "id": 505, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with\n" + } + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "NewResult" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 501, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 238, + "character": 2 + } + ], + "signatures": [ + { + "id": 502, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 444, + "name": "select", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 19, + "character": 2 + } + ], + "signatures": [ + { + "id": 445, + "name": "select", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + }, + "typeParameter": [ + { + "id": 446, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 447, + "name": "NewResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 347, + "name": "Query" + } + ], + "name": "GetResult" + } + } + ], + "parameters": [ + { + "id": 448, + "name": "columns", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The columns to retrieve, separated by commas\n" + }, + "type": { + "type": "reference", + "id": 347, + "name": "Query" + } + } + ], + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "id": 348, + "name": "NewResultOne" + } + } + ], + "name": "default" + } + } + ] + }, + { + "id": 481, + "name": "single", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 136, + "character": 2 + } + ], + "signatures": [ + { + "id": 482, + "name": "single", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" + }, + "typeParameter": [ + { + "id": 483, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 442, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "id": 384, + "name": "ResultOne" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 521, + "name": "then", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 48, + "character": 2 + } + ], + "signatures": [ + { + "id": 522, + "name": "then", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 523, + "name": "TResult1", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 524, + "name": "TResult2", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "never" + } + } + ], + "parameters": [ + { + "id": 525, + "name": "onfulfilled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 526, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 527, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 528, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 529, + "name": "onrejected", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 530, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 531, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 532, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 425, + "name": "TResult2" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 425, + "name": "TResult2" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "id": 424, + "name": "TResult1" + }, + { + "type": "reference", + "id": 425, + "name": "TResult2" + } + ] + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "inheritedFrom": { + "type": "reference", + "id": 557, + "name": "default.then" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 556, + "name": "default.then" + } + }, + { + "id": 519, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 520, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", + "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + }, + "type": { + "type": "reference", + "id": 437, + "typeArguments": [ + { + "type": "reference", + "id": 440, + "name": "Schema" + }, + { + "type": "reference", + "id": 441, + "name": "Row" + }, + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 555, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 554, + "name": "default.throwOnError" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 438 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 510, + 513, + 508, + 518, + 506, + 509, + 511, + 512, + 507 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 478, + 487, + 491, + 489, + 465, + 484, + 449, + 471, + 503, + 501, + 444, + 481, + 521, + 519 + ] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 5, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 533, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 534, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 535, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 536, + "typeArguments": [ + { + "type": "reference", + "id": 442, + "name": "Result" + } + ], + "name": "default" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 114, + "name": "PostgrestFilterBuilder" + } + ] + }, + { + "id": 571, + "name": "PostgrestResponseFailure", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 574, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 573, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 572, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 30, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 588, + "name": "PostgrestError" + } + }, + { + "id": 575, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 21, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.status" + } + }, + { + "id": 576, + "name": "statusText", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 22, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.statusText" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 574, + 573, + 572, + 575, + 576 + ] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 29, + "character": 17 + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "PostgrestResponseBase" + } + ] + }, + { + "id": 577, + "name": "PostgrestResponseSuccess", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 580, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 27, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 579, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 26, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 583, + "name": "T" + } + }, + { + "id": 578, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 25, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 581, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 21, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.status" + } + }, + { + "id": 582, + "name": "statusText", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 22, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.statusText" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 580, + 579, + 578, + 581, + 582 + ] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 24, + "character": 17 + } + ], + "typeParameter": [ + { + "id": 583, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "PostgrestResponseBase" + } + ] + }, + { + "id": 588, + "name": "PostgrestError", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "Error format", + "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + }, + "sources": [ + { + "fileName": "src/types.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 589, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 593, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 12, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 591, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 10, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 592, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 590, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 593, + 591, + 592, + 590 + ] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 8, + "character": 29 + } + ] + } + } + }, + { + "id": 586, + "name": "PostgrestMaybeSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 39, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 587, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "id": 587, + "name": "T" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 569, + "name": "PostgrestResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 40, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 570, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reference", + "id": 584, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "id": 570, + "name": "T" + } + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 584, + "name": "PostgrestSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 38, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 585, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 577, + "typeArguments": [ + { + "type": "reference", + "id": 585, + "name": "T" + } + ], + "name": "PostgrestResponseSuccess" + }, + { + "type": "reference", + "id": 571, + "name": "PostgrestResponseFailure" + } + ] + } + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [ + 536, + 1, + 114, + 49, + 437 + ] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [ + 571, + 577 + ] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [ + 588, + 586, + 569, + 584 + ] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json b/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json index 04991e4d89d..6830f856612 100644 --- a/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json @@ -75,17 +75,32 @@ { "title": "Constructors", "kind": 512, - "children": [537] + "children": [ + 537 + ] }, { "title": "Properties", "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] }, { "title": "Methods", "kind": 2048, - "children": [556, 554] + "children": [ + 556, + 554 + ] } ], "sources": [ @@ -152,26 +167,6 @@ } ] }, - { - "id": 553, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, { "id": 545, "name": "body", @@ -315,6 +310,26 @@ "name": "Record" } }, + { + "id": 553, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 541, "name": "method", @@ -729,17 +744,32 @@ { "title": "Constructors", "kind": 512, - "children": [537] + "children": [ + 537 + ] }, { "title": "Properties", "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] }, { "title": "Methods", "kind": 2048, - "children": [556, 554] + "children": [ + 556, + 554 + ] } ], "sources": [ @@ -1121,7 +1151,11 @@ { "title": "Properties", "kind": 1024, - "children": [12, 10, 11] + "children": [ + 12, + 10, + 11 + ] } ] } @@ -1680,7 +1714,10 @@ { "title": "Properties", "kind": 1024, - "children": [45, 44] + "children": [ + 45, + 44 + ] } ] } @@ -1798,17 +1835,27 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [ + 2 + ] }, { "title": "Properties", "kind": 1024, - "children": [20, 18, 19, 17] + "children": [ + 20, + 18, + 19, + 17 + ] }, { "title": "Methods", "kind": 2048, - "children": [25, 36] + "children": [ + 25, + 36 + ] } ], "sources": [ @@ -2105,26 +2152,6 @@ } ] }, - { - "id": 553, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, { "id": 545, "name": "body", @@ -2268,6 +2295,26 @@ "name": "Record" } }, + { + "id": 553, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 541, "name": "method", @@ -2682,17 +2729,32 @@ { "title": "Constructors", "kind": 512, - "children": [537] + "children": [ + 537 + ] }, { "title": "Properties", "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] }, { "title": "Methods", "kind": 2048, - "children": [556, 554] + "children": [ + 556, + 554 + ] } ], "sources": [ @@ -2779,31 +2841,6 @@ "name": "default.constructor" } }, - { - "id": 419, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 518, - "name": "default.allowEmpty" - } - }, { "id": 411, "name": "body", @@ -2962,6 +2999,31 @@ "name": "default.headers" } }, + { + "id": 419, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 518, + "name": "default.isMaybeSingle" + } + }, { "id": 407, "name": "method", @@ -3640,7 +3702,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 166, "character": 2 } ], @@ -3853,7 +3915,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 194, + "line": 200, "character": 2 } ], @@ -3901,7 +3963,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 202, + "line": 208, "character": 4 } ], @@ -3924,7 +3986,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, + "line": 211, "character": 4 } ], @@ -3947,7 +4009,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, + "line": 213, "character": 4 } ], @@ -3979,7 +4041,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, + "line": 210, "character": 4 } ], @@ -4002,7 +4064,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, + "line": 209, "character": 4 } ], @@ -4025,7 +4087,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, + "line": 212, "character": 4 } ], @@ -4039,7 +4101,14 @@ { "title": "Properties", "kind": 1024, - "children": [396, 399, 401, 398, 397, 400] + "children": [ + 396, + 399, + 401, + 398, + 397, + 400 + ] } ] } @@ -4389,7 +4458,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 174, "character": 2 } ], @@ -6209,7 +6278,9 @@ { "title": "Properties", "kind": 1024, - "children": [371] + "children": [ + 371 + ] } ] } @@ -7270,7 +7341,9 @@ { "title": "Properties", "kind": 1024, - "children": [334] + "children": [ + 334 + ] } ] } @@ -7451,7 +7524,11 @@ { "title": "Properties", "kind": 1024, - "children": [356, 358, 357] + "children": [ + 356, + 358, + 357 + ] } ] } @@ -7603,7 +7680,11 @@ { "title": "Properties", "kind": 1024, - "children": [363, 365, 364] + "children": [ + 363, + 365, + 364 + ] } ] } @@ -7932,7 +8013,9 @@ { "title": "Properties", "kind": 1024, - "children": [378] + "children": [ + 378 + ] } ] } @@ -8759,7 +8842,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 246, + "line": 252, "character": 2 } ], @@ -8829,7 +8912,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 232, + "line": 238, "character": 2 } ], @@ -9238,7 +9321,10 @@ { "title": "Properties", "kind": 1024, - "children": [304, 305] + "children": [ + 304, + 305 + ] } ] } @@ -9390,7 +9476,10 @@ { "title": "Properties", "kind": 1024, - "children": [311, 312] + "children": [ + 311, + 312 + ] } ] } @@ -9730,20 +9819,70 @@ { "title": "Constructors", "kind": 512, - "children": [115] + "children": [ + 115 + ] }, { "title": "Properties", "kind": 1024, - "children": [419, 411, 414, 409, 407, 410, 412, 413, 408] + "children": [ + 411, + 414, + 409, + 419, + 407, + 410, + 412, + 413, + 408 + ] }, { "title": "Methods", "kind": 2048, "children": [ - 379, 241, 233, 388, 121, 392, 335, 390, 137, 145, 193, 201, 209, 225, 217, 169, 177, - 185, 366, 153, 161, 313, 385, 129, 319, 329, 350, 289, 372, 281, 249, 257, 265, 273, - 404, 402, 345, 382, 297, 422, 420 + 379, + 241, + 233, + 388, + 121, + 392, + 335, + 390, + 137, + 145, + 193, + 201, + 209, + 225, + 217, + 169, + 177, + 185, + 366, + 153, + 161, + 313, + 385, + 129, + 319, + 329, + 350, + 289, + 372, + 281, + 249, + 257, + 265, + 273, + 404, + 402, + 345, + 382, + 297, + 422, + 420 ] } ], @@ -10058,7 +10197,11 @@ { "title": "Properties", "kind": 1024, - "children": [59, 57, 58] + "children": [ + 59, + 57, + 58 + ] } ] } @@ -10352,7 +10495,9 @@ { "title": "Properties", "kind": 1024, - "children": [111] + "children": [ + 111 + ] } ] } @@ -10552,7 +10697,10 @@ { "title": "Properties", "kind": 1024, - "children": [88, 89] + "children": [ + 88, + 89 + ] } ] } @@ -10768,7 +10916,10 @@ { "title": "Properties", "kind": 1024, - "children": [81, 80] + "children": [ + 81, + 80 + ] } ] } @@ -10937,7 +11088,9 @@ { "title": "Properties", "kind": 1024, - "children": [106] + "children": [ + 106 + ] } ] } @@ -11183,7 +11336,12 @@ { "title": "Properties", "kind": 1024, - "children": [98, 99, 97, 96] + "children": [ + 98, + 99, + 97, + 96 + ] } ] } @@ -11227,17 +11385,31 @@ { "title": "Constructors", "kind": 512, - "children": [50] + "children": [ + 50 + ] }, { "title": "Properties", "kind": 1024, - "children": [68, 65, 66, 67, 64] + "children": [ + 68, + 65, + 66, + 67, + 64 + ] }, { "title": "Methods", "kind": 2048, - "children": [107, 82, 73, 100, 90] + "children": [ + 107, + 82, + 73, + 100, + 90 + ] } ], "sources": [ @@ -11437,26 +11609,6 @@ } ] }, - { - "id": 553, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, { "id": 545, "name": "body", @@ -11600,6 +11752,26 @@ "name": "Record" } }, + { + "id": 553, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 541, "name": "method", @@ -12014,17 +12186,32 @@ { "title": "Constructors", "kind": 512, - "children": [537] + "children": [ + 537 + ] }, { "title": "Properties", "kind": 1024, - "children": [553, 545, 548, 543, 541, 544, 546, 547, 542] + "children": [ + 545, + 548, + 543, + 553, + 541, + 544, + 546, + 547, + 542 + ] }, { "title": "Methods", "kind": 2048, - "children": [556, 554] + "children": [ + 556, + 554 + ] } ], "sources": [ @@ -12111,31 +12298,6 @@ "name": "default.constructor" } }, - { - "id": 518, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 553, - "name": "default.allowEmpty" - } - }, { "id": 510, "name": "body", @@ -12294,6 +12456,31 @@ "name": "default.headers" } }, + { + "id": 518, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 553, + "name": "default.isMaybeSingle" + } + }, { "id": 506, "name": "method", @@ -12522,7 +12709,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 166, "character": 2 } ], @@ -12559,7 +12746,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 194, + "line": 200, "character": 2 } ], @@ -12607,7 +12794,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 202, + "line": 208, "character": 4 } ], @@ -12630,7 +12817,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, + "line": 211, "character": 4 } ], @@ -12653,7 +12840,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, + "line": 213, "character": 4 } ], @@ -12685,7 +12872,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, + "line": 210, "character": 4 } ], @@ -12708,7 +12895,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, + "line": 209, "character": 4 } ], @@ -12731,7 +12918,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, + "line": 212, "character": 4 } ], @@ -12745,7 +12932,14 @@ { "title": "Properties", "kind": 1024, - "children": [495, 498, 500, 497, 496, 499] + "children": [ + 495, + 498, + 500, + 497, + 496, + 499 + ] } ] } @@ -12807,7 +13001,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 174, "character": 2 } ], @@ -12932,7 +13126,9 @@ { "title": "Properties", "kind": 1024, - "children": [470] + "children": [ + 470 + ] } ] } @@ -13193,7 +13389,11 @@ { "title": "Properties", "kind": 1024, - "children": [455, 457, 456] + "children": [ + 455, + 457, + 456 + ] } ] } @@ -13340,7 +13540,11 @@ { "title": "Properties", "kind": 1024, - "children": [462, 464, 463] + "children": [ + 462, + 464, + 463 + ] } ] } @@ -13471,7 +13675,9 @@ { "title": "Properties", "kind": 1024, - "children": [477] + "children": [ + 477 + ] } ] } @@ -13513,7 +13719,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 246, + "line": 252, "character": 2 } ], @@ -13573,7 +13779,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 232, + "line": 238, "character": 2 } ], @@ -14109,17 +14315,44 @@ { "title": "Constructors", "kind": 512, - "children": [438] + "children": [ + 438 + ] }, { "title": "Properties", "kind": 1024, - "children": [518, 510, 513, 508, 506, 509, 511, 512, 507] + "children": [ + 510, + 513, + 508, + 518, + 506, + 509, + 511, + 512, + 507 + ] }, { "title": "Methods", "kind": 2048, - "children": [478, 487, 491, 489, 465, 484, 449, 471, 503, 501, 444, 481, 521, 519] + "children": [ + 478, + 487, + 491, + 489, + 465, + 484, + 449, + 471, + 503, + 501, + 444, + 481, + 521, + 519 + ] } ], "sources": [ @@ -14357,7 +14590,12 @@ { "title": "Properties", "kind": 1024, - "children": [593, 591, 592, 590] + "children": [ + 593, + 591, + 592, + 590 + ] } ], "sources": [ @@ -14421,7 +14659,13 @@ { "title": "Properties", "kind": 1024, - "children": [574, 573, 572, 575, 576] + "children": [ + 574, + 573, + 572, + 575, + 576 + ] } ], "sources": [ @@ -14559,7 +14803,13 @@ { "title": "Properties", "kind": 1024, - "children": [580, 579, 578, 581, 582] + "children": [ + 580, + 579, + 578, + 581, + 582 + ] } ], "sources": [ @@ -14688,7 +14938,12 @@ { "title": "Properties", "kind": 1024, - "children": [593, 591, 592, 590] + "children": [ + 593, + 591, + 592, + 590 + ] } ], "sources": [ @@ -14929,7 +15184,13 @@ { "title": "Properties", "kind": 1024, - "children": [580, 579, 578, 581, 582] + "children": [ + 580, + 579, + 578, + 581, + 582 + ] } ], "sources": [ @@ -15118,7 +15379,12 @@ { "title": "Properties", "kind": 1024, - "children": [593, 591, 592, 590] + "children": [ + 593, + 591, + 592, + 590 + ] } ], "sources": [ @@ -15182,7 +15448,13 @@ { "title": "Properties", "kind": 1024, - "children": [574, 573, 572, 575, 576] + "children": [ + 574, + 573, + 572, + 575, + 576 + ] } ], "sources": [ @@ -15207,17 +15479,31 @@ { "title": "Classes", "kind": 128, - "children": [536, 1, 114, 49, 437] + "children": [ + 536, + 1, + 114, + 49, + 437 + ] }, { "title": "Interfaces", "kind": 256, - "children": [571, 577] + "children": [ + 571, + 577 + ] }, { "title": "Type Aliases", "kind": 4194304, - "children": [588, 586, 569, 584] + "children": [ + 588, + 586, + 569, + 584 + ] } ], "sources": [ @@ -15227,4 +15513,4 @@ "character": 0 } ] -} +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/realtime.json b/spec/enrichments/tsdoc_v2/realtime.json index 2a7e77b2150..050af38f70e 100644 --- a/spec/enrichments/tsdoc_v2/realtime.json +++ b/spec/enrichments/tsdoc_v2/realtime.json @@ -1,6305 +1,6492 @@ { - "id": 0, - "name": "@supabase/realtime-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 535, - "name": "REALTIME_LISTEN_TYPES", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 536, - "name": "BROADCAST", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - }, - "defaultValue": "\"broadcast\"" - }, - { - "id": 538, - "name": "POSTGRES_CHANGES", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "comment": { - "shortText": "listen to Postgres changes." - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 98, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - }, - "defaultValue": "\"postgres_changes\"" - }, - { - "id": 537, - "name": "PRESENCE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "presence" - }, - "defaultValue": "\"presence\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [536, 538, 537] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 92, - "character": 12 - } - ] - }, - { - "id": 539, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 540, - "name": "ALL", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "*" - }, - "defaultValue": "\"*\"" - }, - { - "id": 543, - "name": "DELETE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "DELETE" - }, - "defaultValue": "\"DELETE\"" - }, - { - "id": 541, - "name": "INSERT", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "INSERT" - }, - "defaultValue": "\"INSERT\"" - }, - { - "id": 542, - "name": "UPDATE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - }, - "defaultValue": "\"UPDATE\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [540, 543, 541, 542] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 85, - "character": 12 - } - ] - }, - { - "id": 544, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 546, - "name": "JOIN", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "join" - }, - "defaultValue": "\"join\"" - }, - { - "id": 547, - "name": "LEAVE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "leave" - }, - "defaultValue": "\"leave\"" - }, - { - "id": 545, - "name": "SYNC", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "sync" - }, - "defaultValue": "\"sync\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [546, 547, 545] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 35, - "character": 12 - } - ] - }, - { - "id": 548, - "name": "REALTIME_SUBSCRIBE_STATES", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 552, - "name": "CHANNEL_ERROR", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 105, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" - }, - { - "id": 551, - "name": "CLOSED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" - }, - { - "id": 549, - "name": "SUBSCRIBED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - }, - "defaultValue": "\"SUBSCRIBED\"" - }, - { - "id": 550, - "name": "TIMED_OUT", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - }, - "defaultValue": "\"TIMED_OUT\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [552, 551, 549, 550] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 101, - "character": 12 - } - ] - }, - { - "id": 64, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": [ - { - "id": 75, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 130, - "character": 2 - } - ], - "signatures": [ - { - "id": 76, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 77, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 316, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - }, - { - "id": 79, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 328, - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 80, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 82, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 83, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 84, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 118, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 86, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 117, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 117, - "character": 14 - } - ], - "indexSignature": { - "id": 88, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 89, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 91, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 119, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 85, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 116, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90, 86, 91, 85] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 115, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 95, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 125, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 94, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 124, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 100, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 316, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - }, - { - "id": 98, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - }, - { - "id": 97, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 127, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 96, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 126, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 101, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 328, - "name": "default" - } - }, - { - "id": 93, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 123, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 92, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 122, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 99, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 133, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 338, - "character": 2 - } - ], - "signatures": [ - { - "id": 134, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "parameters": [ - { - "id": 135, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 136, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 137, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 138, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 340, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [138] - } - ] - } - } - }, - { - "id": 139, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 141, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 142, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 146, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 144, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 145, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 147, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 148, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 149, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 150, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 345, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [150] - } - ] - } - } - }, - { - "id": 151, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 153, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 154, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 505, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "T" - } - ], - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 155, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 159, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 156, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 157, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 158, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 160, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 161, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 162, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 163, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 350, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [163] - } - ] - } - } - }, - { - "id": 164, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 166, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 167, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 515, - "typeArguments": [ - { - "type": "reference", - "id": 159, - "name": "T" - } - ], - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 168, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 172, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 169, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 170, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 171, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 173, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 174, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 464, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 175, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 176, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 177, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 178, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 471, - "typeArguments": [ - { - "type": "reference", - "id": 172, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 179, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 183, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 181, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 182, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 184, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 185, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 464, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 186, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 187, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 188, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 189, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 476, - "typeArguments": [ - { - "type": "reference", - "id": 183, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 190, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 194, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 191, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 192, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 193, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 195, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 196, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 464, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 197, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 198, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 199, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 200, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 486, - "typeArguments": [ - { - "type": "reference", - "id": 194, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 201, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 205, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 202, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 203, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 204, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 206, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 207, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 464, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 208, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 209, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 210, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 211, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 495, - "typeArguments": [ - { - "type": "reference", - "id": 205, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 212, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - }, - "parameters": [ - { - "id": 213, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 214, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 215, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 216, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 381, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [216] - } - ] - } - } - }, - { - "id": 217, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Function to be invoked when event handler is triggered.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 219, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 220, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 223, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 384, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 222, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 383, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [223, 222] - } - ], - "indexSignature": { - "id": 224, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 225, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 110, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 303, - "character": 2 - } - ], - "signatures": [ - { - "id": 111, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 116, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 112, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 113, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 114, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "id": 525, - "typeArguments": [ - { - "type": "reference", - "id": 116, - "name": "T" - } - ], - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 226, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 396, - "character": 2 - } - ], - "signatures": [ - { - "id": 227, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 228, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 229, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 230, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 397, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [230] - } - ], - "indexSignature": { - "id": 231, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 232, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 233, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 234, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 235, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 236, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 327, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 102, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 190, - "character": 2 - } - ], - "signatures": [ - { - "id": 103, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 104, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 106, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 107, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "SUBSCRIBED" - }, - { - "type": "literal", - "value": "TIMED_OUT" - }, - { - "type": "literal", - "value": "CLOSED" - }, - { - "type": "literal", - "value": "CHANNEL_ERROR" - } - ] - } - }, - { - "id": 108, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 109, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 117, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 309, - "character": 8 - } - ], - "signatures": [ - { - "id": 118, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 119, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 120, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 121, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 122, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 123, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 124, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 125, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 126, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 327, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 243, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 436, - "character": 2 - } - ], - "signatures": [ - { - "id": 244, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" - }, - "parameters": [ - { - "id": 245, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 127, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 323, - "character": 8 - } - ], - "signatures": [ - { - "id": 128, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 129, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 130, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 131, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 132, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 327, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 237, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 423, - "character": 2 - } - ], - "signatures": [ - { - "id": 238, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 239, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 240, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 241, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 242, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] - }, - { - "title": "Methods", - "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 113, - "character": 21 - } - ] - }, - { - "id": 328, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 329, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 89, - "character": 2 - } - ], - "signatures": [ - { - "id": 330, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 331, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 332, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 440, - "name": "RealtimeClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 328, - "name": "default" - } - } - ] - }, - { - "id": 333, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 334, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 355, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 58, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "qualifiedName": "WebSocket", - "package": "typescript", - "name": "WebSocket" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 353, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 352, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 55, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 335, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 364, - "name": "eventsPerSecondLimitMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "100" - }, - { - "id": 336, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 45, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 337, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 338, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 339, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 346, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 347, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timer", - "package": "@types/node", - "name": "Timer" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 365, - "name": "inThrottle", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 351, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 54, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 340, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 46, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 341, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 342, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 343, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 348, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 354, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 350, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 53, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 349, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 52, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 356, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 59, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 357, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 60, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 358, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 361, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 362, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 64, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 363, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 65, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 360, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [361, 362, 363, 360] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 344, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 345, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "defaultValue": "w3cwebsocket" - }, - { - "id": 388, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 227, - "character": 2 - } - ], - "signatures": [ - { - "id": 389, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 390, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 391, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 316, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ] - }, - { - "id": 366, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 126, - "character": 2 - } - ], - "signatures": [ - { - "id": 367, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 384, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 207, - "character": 2 - } - ], - "signatures": [ - { - "id": 385, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 368, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 148, - "character": 2 - } - ], - "signatures": [ - { - "id": 369, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 370, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 371, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 372, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 166, - "character": 2 - } - ], - "signatures": [ - { - "id": 373, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all created channels" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 64, - "name": "default" - } - } - } - ] - }, - { - "id": 386, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 223, - "character": 2 - } - ], - "signatures": [ - { - "id": 387, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 379, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 200, - "character": 2 - } - ], - "signatures": [ - { - "id": 380, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 381, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 382, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 383, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 392, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 245, - "character": 2 - } - ], - "signatures": [ - { - "id": 393, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 394, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 457, - "name": "RealtimeMessage" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "literal", - "value": "rate limited" - } - ] - } - } - ] - }, - { - "id": 377, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 187, - "character": 8 - } - ], - "signatures": [ - { - "id": 378, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all channels" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 534, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 374, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 174, - "character": 8 - } - ], - "signatures": [ - { - "id": 375, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes a single channel" - }, - "parameters": [ - { - "id": 376, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A RealtimeChannel instance\n" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 534, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 395, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 272, - "character": 2 - } - ], - "signatures": [ - { - "id": 396, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." - }, - "parameters": [ - { - "id": 397, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [329] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, 348, 354, 350, 349, - 356, 357, 358, 344, 345 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 41, - "character": 21 - } - ] - }, - { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 36, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 84, - "character": 2 - } - ], - "signatures": [ - { - "id": 37, - "name": "new RealtimePresence", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Presence." - }, - "parameters": [ - { - "id": 38, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The RealtimeChannel" - }, - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 39, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" - }, - "type": { - "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" - } - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 44, - "name": "caller", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 67, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 45, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 46, - "name": "onJoin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 68, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" - } - }, - { - "id": 47, - "name": "onLeave", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 69, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" - } - }, - { - "id": 48, - "name": "onSync", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 70, - "character": 4 - } - ], - "signatures": [ - { - "id": 49, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [46, 47] - }, - { - "title": "Methods", - "kind": 2048, - "children": [48] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 50, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 64, - "name": "default" - } - }, - { - "id": 43, - "name": "joinRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 66, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 42, - "name": "pendingDiffs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 65, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "RawPresenceDiff" - } - }, - "defaultValue": "[]" - }, - { - "id": 40, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 525, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 41, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ], - "name": "RealtimePresenceState" - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44, 50, 43, 42, 40] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 63, - "character": 21 - } - ] - }, - { - "id": 316, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 317, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 318, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 16, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 320, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 21, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 323, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 21, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 322, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 21, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [323, 322] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 21, - "character": 16 - } - ] - } - } - }, - { - "id": 324, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 325, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 326, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 25, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [326] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 25, - "character": 15 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [320, 324] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 16, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [318] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 15, - "character": 37 - } - ] - } - } - }, - { - "id": 327, - "name": "RealtimeChannelSendResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 83, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "rate limited" - } - ] - } - }, - { - "id": 440, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 17, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 441, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 447, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 446, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 449, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 450, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 25, - "character": 12 - } - ], - "indexSignature": { - "id": 451, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 452, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 444, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 20, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 445, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 453, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 26, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 26, - "character": 11 - } - ], - "indexSignature": { - "id": 455, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 456, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 448, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 443, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 442, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "WebSocket", - "package": "typescript", - "name": "WebSocket" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [447, 446, 449, 444, 445, 453, 448, 443, 442] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 17, - "character": 36 - } - ] - } - } - }, - { - "id": 457, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 29, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 458, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 460, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 463, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 461, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 462, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 459, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [460, 463, 461, 462, 459] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 29, - "character": 30 - } - ] - } - } - }, - { - "id": 464, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 62, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 470, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 539, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 465, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 466, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of database change to listen to." - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 68, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 470, - "name": "T" - } - }, - { - "id": 469, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Receive database changes when filter is matched." - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 80, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 467, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The database schema to listen to." - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 468, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The database table to listen to." - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 76, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [466, 469, 467, 468] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 64, - "character": 4 - } - ] - } - } - }, - { - "id": 471, - "name": "RealtimePostgresChangesPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 57, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 475, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 472, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 57, - "character": 53 - } - ], - "indexSignature": { - "id": 473, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 474, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 476, - "typeArguments": [ - { - "type": "reference", - "id": 475, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - }, - { - "type": "reference", - "id": 486, - "typeArguments": [ - { - "type": "reference", - "id": 475, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - }, - { - "type": "reference", - "id": 495, - "typeArguments": [ - { - "type": "reference", - "id": 475, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - ] - } - }, - { - "id": 495, - "name": "RealtimePostgresDeletePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 50, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 504, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 501, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 50, - "character": 52 - } - ], - "indexSignature": { - "id": 502, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 503, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 496, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 497, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 543, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "" - ] - ] - } - }, - { - "id": 498, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 499, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 53, - "character": 9 - } - ] - } - } - }, - { - "id": 500, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 54, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 504, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [497, 498, 500] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 51, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 476, - "name": "RealtimePostgresInsertPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 36, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 485, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 482, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 36, - "character": 52 - } - ], - "indexSignature": { - "id": 483, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 484, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 477, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 478, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 38, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 541, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "" - ] - ] - } - }, - { - "id": 479, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 39, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 485, - "name": "T" - } - }, - { - "id": 480, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 481, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 40, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [478, 479, 480] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 37, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 486, - "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 43, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 494, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 491, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 43, - "character": 52 - } - ], - "indexSignature": { - "id": 492, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 493, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 487, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 488, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 542, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "" - ] - ] - } - }, - { - "id": 489, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 46, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 494, - "name": "T" - } - }, - { - "id": 490, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 494, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [488, 489, 490] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 44, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 505, - "name": "RealtimePresenceJoinPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 21, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 514, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 511, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 21, - "character": 50 - } - ], - "indexSignature": { - "id": 512, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 513, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 506, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 509, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 514, - "name": "T" - } - ], - "name": "Presence" - } - } - }, - { - "id": 507, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 546, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "" - ] - ] - } - }, - { - "id": 508, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 510, - "name": "newPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 514, - "name": "T" - } - ], - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [509, 507, 508, 510] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 21, - "character": 76 - } - ] - } - } - }, - { - "id": 515, - "name": "RealtimePresenceLeavePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 28, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 524, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 521, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 28, - "character": 51 - } - ], - "indexSignature": { - "id": 522, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 523, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 516, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 519, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 524, - "name": "T" - } - ], - "name": "Presence" - } - } - }, - { - "id": 517, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 547, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "" - ] - ] - } - }, - { - "id": 518, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 520, - "name": "leftPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 524, - "name": "T" - } - ], - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [519, 517, 518, 520] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 28, - "character": 77 - } - ] - } - } - }, - { - "id": 525, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 17, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 533, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 529, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 17, - "character": 44 - } - ], - "indexSignature": { - "id": 530, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 531, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 532, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 17, - "character": 69 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 526, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 17, - "character": 75 - } - ], - "indexSignature": { - "id": 527, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 528, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "name": "T" - } - ], - "name": "Presence" - } - } - } - } - } - }, - { - "id": 534, - "name": "RealtimeRemoveChannelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 37, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - } - ] - } - } - ], - "groups": [ - { - "title": "Enumerations", - "kind": 8, - "children": [535, 539, 544, 548] - }, - { - "title": "Classes", - "kind": 128, - "children": [64, 328, 1] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [316, 327, 440, 457, 464, 471, 495, 476, 486, 505, 515, 525, 534] - } - ], - "sources": [ - { - "fileName": "index.ts", - "line": 1, - "character": 0 - } - ] -} + "id": 0, + "name": "@supabase/realtime-js", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 535, + "name": "REALTIME_LISTEN_TYPES", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 536, + "name": "BROADCAST", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 93, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "broadcast" + }, + "defaultValue": "\"broadcast\"" + }, + { + "id": 538, + "name": "POSTGRES_CHANGES", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "shortText": "listen to Postgres changes." + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 98, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "postgres_changes" + }, + "defaultValue": "\"postgres_changes\"" + }, + { + "id": 537, + "name": "PRESENCE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 94, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "presence" + }, + "defaultValue": "\"presence\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [ + 536, + 538, + 537 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 92, + "character": 12 + } + ] + }, + { + "id": 539, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 540, + "name": "ALL", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "*" + }, + "defaultValue": "\"*\"" + }, + { + "id": 543, + "name": "DELETE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 89, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "DELETE" + }, + "defaultValue": "\"DELETE\"" + }, + { + "id": 541, + "name": "INSERT", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 87, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "INSERT" + }, + "defaultValue": "\"INSERT\"" + }, + { + "id": 542, + "name": "UPDATE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "UPDATE" + }, + "defaultValue": "\"UPDATE\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [ + 540, + 543, + 541, + 542 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 85, + "character": 12 + } + ] + }, + { + "id": 544, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 546, + "name": "JOIN", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "join" + }, + "defaultValue": "\"join\"" + }, + { + "id": 547, + "name": "LEAVE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 38, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "leave" + }, + "defaultValue": "\"leave\"" + }, + { + "id": 545, + "name": "SYNC", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 36, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "sync" + }, + "defaultValue": "\"sync\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [ + 546, + 547, + 545 + ] + } + ], + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 35, + "character": 12 + } + ] + }, + { + "id": 548, + "name": "REALTIME_SUBSCRIBE_STATES", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 552, + "name": "CHANNEL_ERROR", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 105, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CHANNEL_ERROR" + }, + "defaultValue": "\"CHANNEL_ERROR\"" + }, + { + "id": 551, + "name": "CLOSED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 104, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CLOSED" + }, + "defaultValue": "\"CLOSED\"" + }, + { + "id": 549, + "name": "SUBSCRIBED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 102, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "SUBSCRIBED" + }, + "defaultValue": "\"SUBSCRIBED\"" + }, + { + "id": 550, + "name": "TIMED_OUT", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 103, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "TIMED_OUT" + }, + "defaultValue": "\"TIMED_OUT\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [ + 552, + 551, + 549, + 550 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 101, + "character": 12 + } + ] + }, + { + "id": 64, + "name": "RealtimeChannel", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + }, + "children": [ + { + "id": 75, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 130, + "character": 2 + } + ], + "signatures": [ + { + "id": 76, + "name": "new RealtimeChannel", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 77, + "name": "topic", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 78, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 316, + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + }, + { + "id": 79, + "name": "socket", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 328, + "name": "default" + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + } + ] + }, + { + "id": 80, + "name": "bindings", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 114, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 81, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 82, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 83, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 84, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 90, + "name": "callback", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 118, + "character": 6 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 86, + "name": "filter", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 117, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 87, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 117, + "character": 14 + } + ], + "indexSignature": { + "id": 88, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 89, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 91, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 119, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 85, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 116, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 90, + 86, + 91, + 85 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 115, + "character": 19 + } + ] + } + } + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 95, + "name": "joinPush", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 125, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "default" + } + }, + { + "id": 94, + "name": "joinedOnce", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 124, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 100, + "name": "params", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "id": 316, + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + }, + { + "id": 98, + "name": "presence", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 128, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + }, + { + "id": 97, + "name": "pushBuffer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 127, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "default" + } + }, + "defaultValue": "[]" + }, + { + "id": 96, + "name": "rejoinTimer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 126, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "default" + } + }, + { + "id": 101, + "name": "socket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "id": 328, + "name": "default" + } + }, + { + "id": 93, + "name": "state", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 123, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "CHANNEL_STATES" + }, + "defaultValue": "CHANNEL_STATES.closed" + }, + { + "id": 92, + "name": "timeout", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 122, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 99, + "name": "topic", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 133, + "name": "on", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 338, + "character": 2 + } + ], + "signatures": [ + { + "id": 134, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates an event handler that listens to changes." + }, + "parameters": [ + { + "id": 135, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 136, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 137, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 138, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 340, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": "sync" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 138 + ] + } + ] + } + } + }, + { + "id": 139, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 140, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 141, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 142, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 146, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 143, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 144, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 145, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 147, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 148, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 149, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 150, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 345, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": "join" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 150 + ] + } + ] + } + } + }, + { + "id": 151, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 152, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 153, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 154, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 505, + "typeArguments": [ + { + "type": "reference", + "id": 146, + "name": "T" + } + ], + "name": "RealtimePresenceJoinPayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 155, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 159, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 156, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 157, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 158, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 160, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 161, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 162, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 163, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 350, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": "leave" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 163 + ] + } + ] + } + } + }, + { + "id": 164, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 165, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 166, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 167, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 515, + "typeArguments": [ + { + "type": "reference", + "id": 159, + "name": "T" + } + ], + "name": "RealtimePresenceLeavePayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 168, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 172, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 169, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 170, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 171, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 173, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 174, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 464, + "typeArguments": [ + { + "type": "literal", + "value": "*" + } + ], + "name": "RealtimePostgresChangesFilter" + } + }, + { + "id": 175, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 176, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 177, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 178, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 471, + "typeArguments": [ + { + "type": "reference", + "id": 172, + "name": "T" + } + ], + "name": "RealtimePostgresChangesPayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 179, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 183, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 180, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 181, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 182, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 184, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 185, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 464, + "typeArguments": [ + { + "type": "literal", + "value": "INSERT" + } + ], + "name": "RealtimePostgresChangesFilter" + } + }, + { + "id": 186, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 187, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 188, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 189, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 476, + "typeArguments": [ + { + "type": "reference", + "id": 183, + "name": "T" + } + ], + "name": "RealtimePostgresInsertPayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 190, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 194, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 191, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 192, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 193, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 195, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 196, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 464, + "typeArguments": [ + { + "type": "literal", + "value": "UPDATE" + } + ], + "name": "RealtimePostgresChangesFilter" + } + }, + { + "id": 197, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 198, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 199, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 200, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 486, + "typeArguments": [ + { + "type": "reference", + "id": 194, + "name": "T" + } + ], + "name": "RealtimePostgresUpdatePayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 201, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 205, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 202, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 203, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 204, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 206, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 207, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 464, + "typeArguments": [ + { + "type": "literal", + "value": "DELETE" + } + ], + "name": "RealtimePostgresChangesFilter" + } + }, + { + "id": 208, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 209, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 210, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 211, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 495, + "typeArguments": [ + { + "type": "reference", + "id": 205, + "name": "T" + } + ], + "name": "RealtimePostgresDeletePayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 212, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." + }, + "parameters": [ + { + "id": 213, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." + }, + "type": { + "type": "literal", + "value": "broadcast" + } + }, + { + "id": 214, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." + }, + "type": { + "type": "reflection", + "declaration": { + "id": 215, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 216, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 381, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 216 + ] + } + ] + } + } + }, + { + "id": 217, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Function to be invoked when event handler is triggered.\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 218, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 219, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 220, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 221, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 223, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 384, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 222, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 383, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": "broadcast" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 223, + 222 + ] + } + ], + "indexSignature": { + "id": 224, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 225, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + } + ] + }, + { + "id": 110, + "name": "presenceState", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 303, + "character": 2 + } + ], + "signatures": [ + { + "id": 111, + "name": "presenceState", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 116, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 112, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 113, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 114, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 115, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + } + ], + "type": { + "type": "reference", + "id": 525, + "typeArguments": [ + { + "type": "reference", + "id": 116, + "name": "T" + } + ], + "name": "RealtimePresenceState" + } + } + ] + }, + { + "id": 226, + "name": "send", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 396, + "character": 2 + } + ], + "signatures": [ + { + "id": 227, + "name": "send", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 228, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 229, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 230, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 397, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 230 + ] + } + ], + "indexSignature": { + "id": 231, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 232, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 233, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 234, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 235, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 236, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 327, + "name": "RealtimeChannelSendResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 102, + "name": "subscribe", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 190, + "character": 2 + } + ], + "signatures": [ + { + "id": 103, + "name": "subscribe", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Subscribe registers your client with the server" + }, + "parameters": [ + { + "id": 104, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 105, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 106, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 107, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "SUBSCRIBED" + }, + { + "type": "literal", + "value": "TIMED_OUT" + }, + { + "type": "literal", + "value": "CLOSED" + }, + { + "type": "literal", + "value": "CHANNEL_ERROR" + } + ] + } + }, + { + "id": 108, + "name": "err", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 109, + "name": "timeout", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + } + ] + }, + { + "id": 117, + "name": "track", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 309, + "character": 8 + } + ], + "signatures": [ + { + "id": 118, + "name": "track", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 119, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 120, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 121, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 122, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 123, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 124, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 125, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 126, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 327, + "name": "RealtimeChannelSendResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 243, + "name": "unsubscribe", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 436, + "character": 2 + } + ], + "signatures": [ + { + "id": 244, + "name": "unsubscribe", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Leaves the channel.", + "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" + }, + "parameters": [ + { + "id": 245, + "name": "timeout", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "error" + }, + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 127, + "name": "untrack", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 323, + "character": 8 + } + ], + "signatures": [ + { + "id": 128, + "name": "untrack", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 129, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 130, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 131, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 132, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 327, + "name": "RealtimeChannelSendResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 237, + "name": "updateJoinPayload", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 238, + "name": "updateJoinPayload", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 239, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 240, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 241, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 242, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 75 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 113, + "character": 21 + } + ] + }, + { + "id": 328, + "name": "RealtimeClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 329, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 89, + "character": 2 + } + ], + "signatures": [ + { + "id": 330, + "name": "new RealtimeClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Initializes the Socket." + }, + "parameters": [ + { + "id": 331, + "name": "endPoint", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 332, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 440, + "name": "RealtimeClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 328, + "name": "default" + } + } + ] + }, + { + "id": 333, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 334, + "name": "channels", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + "defaultValue": "[]" + }, + { + "id": 355, + "name": "conn", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 58, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "qualifiedName": "WebSocket", + "package": "typescript", + "name": "WebSocket" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 353, + "name": "decode", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 352, + "name": "encode", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 55, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 335, + "name": "endPoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 364, + "name": "eventsPerSecondLimitMs", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 72, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "100" + }, + { + "id": 336, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 337, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 338, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 339, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + }, + "defaultValue": "DEFAULT_HEADERS" + }, + { + "id": 346, + "name": "heartbeatIntervalMs", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "30000" + }, + { + "id": 347, + "name": "heartbeatTimer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "qualifiedName": "global.NodeJS.Timer", + "package": "@types/node", + "name": "Timer" + } + ] + }, + "defaultValue": "undefined" + }, + { + "id": 365, + "name": "inThrottle", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 73, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 351, + "name": "logger", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 54, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + }, + "defaultValue": "noop" + }, + { + "id": 340, + "name": "params", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 46, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 341, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 342, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 343, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 348, + "name": "pendingHeartbeatRef", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 51, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 354, + "name": "reconnectAfterMs", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 350, + "name": "reconnectTimer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 53, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "default" + } + }, + { + "id": 349, + "name": "ref", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 52, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 356, + "name": "sendBuffer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 59, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + "defaultValue": "[]" + }, + { + "id": 357, + "name": "serializer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 60, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "default" + }, + "defaultValue": "..." + }, + { + "id": 358, + "name": "stateChangeCallbacks", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 61, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 359, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 361, + "name": "close", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 63, + "character": 4 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + } + }, + { + "id": 362, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 64, + "character": 4 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + } + }, + { + "id": 363, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 65, + "character": 4 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + } + }, + { + "id": 360, + "name": "open", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 62, + "character": 4 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 361, + 362, + 363, + 360 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 344, + "name": "timeout", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "DEFAULT_TIMEOUT" + }, + { + "id": 345, + "name": "transport", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + }, + "defaultValue": "w3cwebsocket" + }, + { + "id": 388, + "name": "channel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 389, + "name": "channel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 390, + "name": "topic", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 391, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 316, + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + } + ] + }, + { + "id": 366, + "name": "connect", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 126, + "character": 2 + } + ], + "signatures": [ + { + "id": 367, + "name": "connect", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Connects the socket, unless already connected." + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 384, + "name": "connectionState", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 207, + "character": 2 + } + ], + "signatures": [ + { + "id": 385, + "name": "connectionState", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the current state of the socket." + }, + "type": { + "type": "reference", + "name": "CONNECTION_STATE" + } + } + ] + }, + { + "id": 368, + "name": "disconnect", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 148, + "character": 2 + } + ], + "signatures": [ + { + "id": 369, + "name": "disconnect", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Disconnects the socket." + }, + "parameters": [ + { + "id": 370, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A numeric status code to send on disconnect." + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 371, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom reason for the disconnect.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 372, + "name": "getChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 166, + "character": 2 + } + ], + "signatures": [ + { + "id": 373, + "name": "getChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns all created channels" + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 64, + "name": "default" + } + } + } + ] + }, + { + "id": 386, + "name": "isConnected", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 223, + "character": 2 + } + ], + "signatures": [ + { + "id": 387, + "name": "isConnected", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns `true` is the connection is open." + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 379, + "name": "log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 200, + "character": 2 + } + ], + "signatures": [ + { + "id": 380, + "name": "log", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Logs the message.", + "text": "For customized logging, `this.logger` can be overridden.\n" + }, + "parameters": [ + { + "id": 381, + "name": "kind", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 382, + "name": "msg", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 383, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 392, + "name": "push", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 245, + "character": 2 + } + ], + "signatures": [ + { + "id": 393, + "name": "push", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Push out a message if the socket is connected.", + "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" + }, + "parameters": [ + { + "id": 394, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 457, + "name": "RealtimeMessage" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "literal", + "value": "rate limited" + } + ] + } + } + ] + }, + { + "id": 377, + "name": "removeAllChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 187, + "character": 8 + } + ], + "signatures": [ + { + "id": 378, + "name": "removeAllChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unsubscribes and removes all channels" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "id": 534, + "name": "RealtimeRemoveChannelResponse" + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 374, + "name": "removeChannel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 174, + "character": 8 + } + ], + "signatures": [ + { + "id": 375, + "name": "removeChannel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unsubscribes and removes a single channel" + }, + "parameters": [ + { + "id": 376, + "name": "channel", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A RealtimeChannel instance\n" + }, + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 534, + "name": "RealtimeRemoveChannelResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 395, + "name": "setAuth", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 272, + "character": 2 + } + ], + "signatures": [ + { + "id": 396, + "name": "setAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + }, + "parameters": [ + { + "id": 397, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A JWT string.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 329 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 41, + "character": 21 + } + ] + }, + { + "id": 1, + "name": "RealtimePresence", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 36, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 84, + "character": 2 + } + ], + "signatures": [ + { + "id": 37, + "name": "new RealtimePresence", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Initializes the Presence." + }, + "parameters": [ + { + "id": 38, + "name": "channel", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The RealtimeChannel" + }, + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 39, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" + }, + "type": { + "type": "reference", + "qualifiedName": "PresenceOpts", + "package": "@types/phoenix", + "name": "PresenceOpts" + } + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + } + ] + }, + { + "id": 44, + "name": "caller", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 67, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 45, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 46, + "name": "onJoin", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 68, + "character": 4 + } + ], + "type": { + "type": "reference", + "qualifiedName": "PresenceOnJoinCallback", + "package": "@types/phoenix", + "name": "PresenceOnJoinCallback" + } + }, + { + "id": 47, + "name": "onLeave", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 69, + "character": 4 + } + ], + "type": { + "type": "reference", + "qualifiedName": "PresenceOnLeaveCallback", + "package": "@types/phoenix", + "name": "PresenceOnLeaveCallback" + } + }, + { + "id": 48, + "name": "onSync", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 70, + "character": 4 + } + ], + "signatures": [ + { + "id": 49, + "name": "onSync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 46, + 47 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 48 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 50, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "id": 64, + "name": "default" + } + }, + { + "id": 43, + "name": "joinRef", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 42, + "name": "pendingDiffs", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 65, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "RawPresenceDiff" + } + }, + "defaultValue": "[]" + }, + { + "id": 40, + "name": "state", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 64, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 525, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 41, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ], + "name": "RealtimePresenceState" + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 36 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 44, + 50, + 43, + 42, + 40 + ] + } + ], + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 63, + "character": 21 + } + ] + }, + { + "id": 316, + "name": "RealtimeChannelOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 15, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 317, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 318, + "name": "config", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 16, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 319, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 320, + "name": "broadcast", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 21, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 321, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 323, + "name": "ack", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 21, + "character": 34 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 322, + "name": "self", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 21, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 323, + 322 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 21, + "character": 16 + } + ] + } + } + }, + { + "id": 324, + "name": "presence", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "key option is used to track presence payload across clients" + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 25, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 325, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 326, + "name": "key", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 25, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 326 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 25, + "character": 15 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 320, + 324 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 16, + "character": 10 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 318 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 15, + "character": 37 + } + ] + } + } + }, + { + "id": 327, + "name": "RealtimeChannelSendResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 83, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + }, + { + "type": "literal", + "value": "rate limited" + } + ] + } + }, + { + "id": 440, + "name": "RealtimeClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 17, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 441, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 447, + "name": "decode", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 446, + "name": "encode", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 22, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 449, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 25, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 450, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 25, + "character": 12 + } + ], + "indexSignature": { + "id": 451, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 452, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 444, + "name": "heartbeatIntervalMs", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 20, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 445, + "name": "logger", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 21, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 453, + "name": "params", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 26, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 454, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 26, + "character": 11 + } + ], + "indexSignature": { + "id": 455, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 456, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 448, + "name": "reconnectAfterMs", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 443, + "name": "timeout", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 19, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 442, + "name": "transport", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "WebSocket", + "package": "typescript", + "name": "WebSocket" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 17, + "character": 36 + } + ] + } + } + }, + { + "id": 457, + "name": "RealtimeMessage", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 29, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 458, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 460, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 463, + "name": "join_ref", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 34, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 461, + "name": "payload", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 462, + "name": "ref", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 459, + "name": "topic", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 30, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 460, + 463, + 461, + 462, + 459 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 29, + "character": 30 + } + ] + } + } + }, + { + "id": 464, + "name": "RealtimePostgresChangesFilter", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 62, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 470, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 539, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" + }, + "" + ] + ] + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 465, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 466, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of database change to listen to." + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 68, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 470, + "name": "T" + } + }, + { + "id": 469, + "name": "filter", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Receive database changes when filter is matched." + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 80, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 467, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The database schema to listen to." + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 72, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 468, + "name": "table", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The database table to listen to." + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 76, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 466, + 469, + 467, + 468 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 64, + "character": 4 + } + ] + } + } + }, + { + "id": 471, + "name": "RealtimePostgresChangesPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 57, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 475, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 472, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 57, + "character": 53 + } + ], + "indexSignature": { + "id": 473, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 474, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 476, + "typeArguments": [ + { + "type": "reference", + "id": 475, + "name": "T" + } + ], + "name": "RealtimePostgresInsertPayload" + }, + { + "type": "reference", + "id": 486, + "typeArguments": [ + { + "type": "reference", + "id": 475, + "name": "T" + } + ], + "name": "RealtimePostgresUpdatePayload" + }, + { + "type": "reference", + "id": 495, + "typeArguments": [ + { + "type": "reference", + "id": 475, + "name": "T" + } + ], + "name": "RealtimePostgresDeletePayload" + } + ] + } + }, + { + "id": 495, + "name": "RealtimePostgresDeletePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 50, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 504, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 501, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 50, + "character": 52 + } + ], + "indexSignature": { + "id": 502, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 503, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 496, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 497, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 52, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 543, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + }, + "" + ] + ] + } + }, + { + "id": 498, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 53, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 499, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 53, + "character": 9 + } + ] + } + } + }, + { + "id": 500, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 54, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 504, + "name": "T" + } + ], + "qualifiedName": "Partial", + "package": "typescript", + "name": "Partial" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 497, + 498, + 500 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 51, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 476, + "name": "RealtimePostgresInsertPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 36, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 485, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 482, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 36, + "character": 52 + } + ], + "indexSignature": { + "id": 483, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 484, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 477, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 478, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 38, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 541, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" + }, + "" + ] + ] + } + }, + { + "id": 479, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 39, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 485, + "name": "T" + } + }, + { + "id": 480, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 40, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 481, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 40, + "character": 9 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 478, + 479, + 480 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 37, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 486, + "name": "RealtimePostgresUpdatePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 43, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 494, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 491, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 43, + "character": 52 + } + ], + "indexSignature": { + "id": 492, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 493, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 487, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 488, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 45, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 542, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + }, + "" + ] + ] + } + }, + { + "id": 489, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 46, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "T" + } + }, + { + "id": 490, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 47, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 494, + "name": "T" + } + ], + "qualifiedName": "Partial", + "package": "typescript", + "name": "Partial" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 488, + 489, + 490 + ] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 44, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 505, + "name": "RealtimePresenceJoinPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 21, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 514, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 511, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 21, + "character": 50 + } + ], + "indexSignature": { + "id": 512, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 513, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 506, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 509, + "name": "currentPresences", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 514, + "name": "T" + } + ], + "name": "Presence" + } + } + }, + { + "id": 507, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 22, + "character": 2 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 546, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" + }, + "" + ] + ] + } + }, + { + "id": 508, + "name": "key", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "newPresences", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 25, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 514, + "name": "T" + } + ], + "name": "Presence" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 509, + 507, + 508, + 510 + ] + } + ], + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 21, + "character": 76 + } + ] + } + } + }, + { + "id": 515, + "name": "RealtimePresenceLeavePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 28, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 524, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 521, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 28, + "character": 51 + } + ], + "indexSignature": { + "id": 522, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 523, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 516, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 519, + "name": "currentPresences", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 524, + "name": "T" + } + ], + "name": "Presence" + } + } + }, + { + "id": 517, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 547, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" + }, + "" + ] + ] + } + }, + { + "id": 518, + "name": "key", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 30, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 520, + "name": "leftPresences", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 524, + "name": "T" + } + ], + "name": "Presence" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 519, + 517, + 518, + 520 + ] + } + ], + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 28, + "character": 77 + } + ] + } + } + }, + { + "id": 525, + "name": "RealtimePresenceState", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 17, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 533, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 529, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 17, + "character": 44 + } + ], + "indexSignature": { + "id": 530, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 531, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 532, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 17, + "character": 69 + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 526, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 17, + "character": 75 + } + ], + "indexSignature": { + "id": 527, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 528, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "T" + } + ], + "name": "Presence" + } + } + } + } + } + }, + { + "id": 534, + "name": "RealtimeRemoveChannelResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 37, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + }, + { + "type": "literal", + "value": "error" + } + ] + } + } + ], + "groups": [ + { + "title": "Enumerations", + "kind": 8, + "children": [ + 535, + 539, + 544, + 548 + ] + }, + { + "title": "Classes", + "kind": 128, + "children": [ + 64, + 328, + 1 + ] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [ + 316, + 327, + 440, + 457, + 464, + 471, + 495, + 476, + 486, + 505, + 515, + 525, + 534 + ] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 1, + "character": 0 + } + ] +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/realtime_dereferenced.json b/spec/enrichments/tsdoc_v2/realtime_dereferenced.json index a8cb87730dd..ad50c2c7a13 100644 --- a/spec/enrichments/tsdoc_v2/realtime_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/realtime_dereferenced.json @@ -78,7 +78,11 @@ { "title": "Enumeration Members", "kind": 16, - "children": [536, 538, 537] + "children": [ + 536, + 538, + 537 + ] } ], "sources": [ @@ -177,7 +181,12 @@ { "title": "Enumeration Members", "kind": 16, - "children": [540, 543, 541, 542] + "children": [ + 540, + 543, + 541, + 542 + ] } ], "sources": [ @@ -257,7 +266,11 @@ { "title": "Enumeration Members", "kind": 16, - "children": [546, 547, 545] + "children": [ + 546, + 547, + 545 + ] } ], "sources": [ @@ -356,7 +369,12 @@ { "title": "Enumeration Members", "kind": 16, - "children": [552, 551, 549, 550] + "children": [ + 552, + 551, + 549, + 550 + ] } ], "sources": [ @@ -535,7 +553,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -600,7 +621,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -618,7 +641,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -636,7 +662,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -1009,7 +1037,15 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, 443, 442 + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 ] } ], @@ -1629,7 +1665,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -1832,7 +1873,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -1897,7 +1941,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -1915,7 +1961,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -1933,7 +1982,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -2368,7 +2419,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -2493,17 +2550,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -2593,20 +2673,54 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, 348, - 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] } ], "sources": [ @@ -2795,7 +2909,12 @@ { "title": "Properties", "kind": 1024, - "children": [90, 86, 91, 85] + "children": [ + 90, + 86, + 91, + 85 + ] } ], "sources": [ @@ -2978,7 +3097,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -3043,7 +3165,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -3061,7 +3185,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -3079,7 +3206,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -3170,17 +3299,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -3314,12 +3466,17 @@ { "title": "Properties", "kind": 1024, - "children": [46, 47] + "children": [ + 46, + 47 + ] }, { "title": "Methods", "kind": 2048, - "children": [48] + "children": [ + 48 + ] } ] } @@ -3352,17 +3509,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -3592,12 +3772,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -4008,7 +4196,17 @@ { "title": "Properties", "kind": 1024, - "children": [447, 446, 449, 444, 445, 453, 448, 443, 442] + "children": [ + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 + ] } ], "sources": [ @@ -4627,7 +4825,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -4830,7 +5033,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -4895,7 +5101,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -4913,7 +5121,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -4931,7 +5142,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -5366,7 +5579,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -5491,17 +5710,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -5591,20 +5833,54 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, 348, 354, 350, - 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] } ], "sources": [ @@ -5740,7 +6016,9 @@ { "title": "Properties", "kind": 1024, - "children": [138] + "children": [ + 138 + ] } ] } @@ -5881,7 +6159,9 @@ { "title": "Properties", "kind": 1024, - "children": [150] + "children": [ + 150 + ] } ] } @@ -6043,7 +6323,9 @@ { "title": "Properties", "kind": 1024, - "children": [163] + "children": [ + 163 + ] } ] } @@ -6323,7 +6605,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -6612,7 +6899,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -6901,7 +7193,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -7190,7 +7487,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -7328,7 +7630,9 @@ { "title": "Properties", "kind": 1024, - "children": [216] + "children": [ + 216 + ] } ] } @@ -7415,7 +7719,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 223, + 222 + ] } ], "indexSignature": { @@ -7609,7 +7916,9 @@ { "title": "Properties", "kind": 1024, - "children": [230] + "children": [ + 230 + ] } ], "indexSignature": { @@ -8156,17 +8465,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -8523,7 +8855,17 @@ { "title": "Properties", "kind": 1024, - "children": [447, 446, 449, 444, 445, 453, 448, 443, 442] + "children": [ + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 + ] } ], "sources": [ @@ -9142,7 +9484,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -9345,7 +9692,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -9410,7 +9760,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -9428,7 +9780,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -9446,7 +9801,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -9881,7 +10238,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -10160,7 +10523,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -10225,7 +10591,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -10243,7 +10611,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -10261,7 +10632,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -10298,21 +10671,53 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, - 351, 340, 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395 + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 ] } ], @@ -10502,7 +10907,12 @@ { "title": "Properties", "kind": 1024, - "children": [90, 86, 91, 85] + "children": [ + 90, + 86, + 91, + 85 + ] } ], "sources": [ @@ -10685,7 +11095,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -10750,7 +11163,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -10768,7 +11183,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -10786,7 +11204,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -10987,12 +11407,17 @@ { "title": "Properties", "kind": 1024, - "children": [46, 47] + "children": [ + 46, + 47 + ] }, { "title": "Methods", "kind": 2048, - "children": [48] + "children": [ + 48 + ] } ] } @@ -11231,12 +11656,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -11312,21 +11745,53 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, - 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395 + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 ] } ], @@ -11463,7 +11928,9 @@ { "title": "Properties", "kind": 1024, - "children": [138] + "children": [ + 138 + ] } ] } @@ -11604,7 +12071,9 @@ { "title": "Properties", "kind": 1024, - "children": [150] + "children": [ + 150 + ] } ] } @@ -11766,7 +12235,9 @@ { "title": "Properties", "kind": 1024, - "children": [163] + "children": [ + 163 + ] } ] } @@ -12046,7 +12517,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -12335,7 +12811,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -12624,7 +13105,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -12913,7 +13399,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -13051,7 +13542,9 @@ { "title": "Properties", "kind": 1024, - "children": [216] + "children": [ + 216 + ] } ] } @@ -13138,7 +13631,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 223, + 222 + ] } ], "indexSignature": { @@ -13332,7 +13828,9 @@ { "title": "Properties", "kind": 1024, - "children": [230] + "children": [ + 230 + ] } ], "indexSignature": { @@ -13879,17 +14377,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -13979,20 +14500,54 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, 348, 354, 350, 349, - 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] } ], "sources": [ @@ -14215,7 +14770,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -14280,7 +14838,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -14298,7 +14858,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -14316,7 +14879,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -14689,8 +15254,15 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, - 443, 442 + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 ] } ], @@ -15310,7 +15882,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -15513,7 +16090,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -15578,7 +16158,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -15596,7 +16178,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -15614,7 +16199,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -16049,7 +16636,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -16240,21 +16833,53 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, - 351, 340, 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395 + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 ] } ], @@ -16444,7 +17069,12 @@ { "title": "Properties", "kind": 1024, - "children": [90, 86, 91, 85] + "children": [ + 90, + 86, + 91, + 85 + ] } ], "sources": [ @@ -16627,7 +17257,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -16692,7 +17325,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -16710,7 +17345,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -16728,7 +17366,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -16772,12 +17412,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -17189,7 +17837,15 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, 443, 442 + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 ] } ], @@ -17809,7 +18465,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -18012,7 +18673,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -18077,7 +18741,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -18095,7 +18761,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -18113,7 +18782,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -18548,7 +19219,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -18739,21 +19416,53 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, - 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395 + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 ] } ], @@ -18890,7 +19599,9 @@ { "title": "Properties", "kind": 1024, - "children": [138] + "children": [ + 138 + ] } ] } @@ -19031,7 +19742,9 @@ { "title": "Properties", "kind": 1024, - "children": [150] + "children": [ + 150 + ] } ] } @@ -19193,7 +19906,9 @@ { "title": "Properties", "kind": 1024, - "children": [163] + "children": [ + 163 + ] } ] } @@ -19473,7 +20188,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -19762,7 +20482,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -20051,7 +20776,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -20340,7 +21070,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -20478,7 +21213,9 @@ { "title": "Properties", "kind": 1024, - "children": [216] + "children": [ + 216 + ] } ] } @@ -20565,7 +21302,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 223, + 222 + ] } ], "indexSignature": { @@ -20759,7 +21499,9 @@ { "title": "Properties", "kind": 1024, - "children": [230] + "children": [ + 230 + ] } ], "indexSignature": { @@ -21306,17 +22048,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -21450,12 +22215,17 @@ { "title": "Properties", "kind": 1024, - "children": [46, 47] + "children": [ + 46, + 47 + ] }, { "title": "Methods", "kind": 2048, - "children": [48] + "children": [ + 48 + ] } ] } @@ -21642,7 +22412,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -21707,7 +22480,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -21725,7 +22500,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -21743,7 +22521,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -22116,7 +22896,15 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, 443, 442 + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 ] } ], @@ -22736,7 +23524,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -22939,7 +23732,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -23004,7 +23800,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -23022,7 +23820,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -23040,7 +23841,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -23475,7 +24278,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -23666,21 +24475,53 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, - 348, 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, "children": [ - 388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395 + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 ] } ], @@ -23870,7 +24711,12 @@ { "title": "Properties", "kind": 1024, - "children": [90, 86, 91, 85] + "children": [ + 90, + 86, + 91, + 85 + ] } ], "sources": [ @@ -24053,7 +24899,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -24118,7 +24967,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -24136,7 +24987,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -24154,7 +25008,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -24198,12 +25054,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -24615,7 +25479,15 @@ "title": "Properties", "kind": 1024, "children": [ - 447, 446, 449, 444, 445, 453, 448, 443, 442 + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 ] } ], @@ -25235,7 +26107,12 @@ { "title": "Properties", "kind": 1024, - "children": [361, 362, 363, 360] + "children": [ + 361, + 362, + 363, + 360 + ] } ] } @@ -25438,7 +26315,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -25503,7 +26383,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -25521,7 +26403,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -25539,7 +26424,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -25974,7 +26861,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -26165,20 +27058,54 @@ { "title": "Constructors", "kind": 512, - "children": [329] + "children": [ + 329 + ] }, { "title": "Properties", "kind": 1024, "children": [ - 333, 334, 355, 353, 352, 335, 364, 336, 346, 347, 365, 351, 340, 348, - 354, 350, 349, 356, 357, 358, 344, 345 + 333, + 334, + 355, + 353, + 352, + 335, + 364, + 336, + 346, + 347, + 365, + 351, + 340, + 348, + 354, + 350, + 349, + 356, + 357, + 358, + 344, + 345 ] }, { "title": "Methods", "kind": 2048, - "children": [388, 366, 384, 368, 372, 386, 379, 392, 377, 374, 395] + "children": [ + 388, + 366, + 384, + 368, + 372, + 386, + 379, + 392, + 377, + 374, + 395 + ] } ], "sources": [ @@ -26314,7 +27241,9 @@ { "title": "Properties", "kind": 1024, - "children": [138] + "children": [ + 138 + ] } ] } @@ -26455,7 +27384,9 @@ { "title": "Properties", "kind": 1024, - "children": [150] + "children": [ + 150 + ] } ] } @@ -26617,7 +27548,9 @@ { "title": "Properties", "kind": 1024, - "children": [163] + "children": [ + 163 + ] } ] } @@ -26897,7 +27830,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -27186,7 +28124,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -27475,7 +28418,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -27764,7 +28712,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -27902,7 +28855,9 @@ { "title": "Properties", "kind": 1024, - "children": [216] + "children": [ + 216 + ] } ] } @@ -27989,7 +28944,10 @@ { "title": "Properties", "kind": 1024, - "children": [223, 222] + "children": [ + 223, + 222 + ] } ], "indexSignature": { @@ -28183,7 +29141,9 @@ { "title": "Properties", "kind": 1024, - "children": [230] + "children": [ + 230 + ] } ], "indexSignature": { @@ -28730,17 +29690,40 @@ { "title": "Constructors", "kind": 512, - "children": [75] + "children": [ + 75 + ] }, { "title": "Properties", "kind": 1024, - "children": [80, 95, 94, 100, 98, 97, 96, 101, 93, 92, 99] + "children": [ + 80, + 95, + 94, + 100, + 98, + 97, + 96, + 101, + 93, + 92, + 99 + ] }, { "title": "Methods", "kind": 2048, - "children": [133, 110, 226, 102, 117, 243, 127, 237] + "children": [ + 133, + 110, + 226, + 102, + 117, + 243, + 127, + 237 + ] } ], "sources": [ @@ -28970,12 +29953,20 @@ { "title": "Constructors", "kind": 512, - "children": [36] + "children": [ + 36 + ] }, { "title": "Properties", "kind": 1024, - "children": [44, 50, 43, 42, 40] + "children": [ + 44, + 50, + 43, + 42, + 40 + ] } ], "sources": [ @@ -29102,7 +30093,10 @@ { "title": "Properties", "kind": 1024, - "children": [323, 322] + "children": [ + 323, + 322 + ] } ], "sources": [ @@ -29167,7 +30161,9 @@ { "title": "Properties", "kind": 1024, - "children": [326] + "children": [ + 326 + ] } ], "sources": [ @@ -29185,7 +30181,10 @@ { "title": "Properties", "kind": 1024, - "children": [320, 324] + "children": [ + 320, + 324 + ] } ], "sources": [ @@ -29203,7 +30202,9 @@ { "title": "Properties", "kind": 1024, - "children": [318] + "children": [ + 318 + ] } ], "sources": [ @@ -29536,7 +30537,17 @@ { "title": "Properties", "kind": 1024, - "children": [447, 446, 449, 444, 445, 453, 448, 443, 442] + "children": [ + 447, + 446, + 449, + 444, + 445, + 453, + 448, + 443, + 442 + ] } ], "sources": [ @@ -29668,7 +30679,13 @@ { "title": "Properties", "kind": 1024, - "children": [460, 463, 461, 462, 459] + "children": [ + 460, + 463, + 461, + 462, + 459 + ] } ], "sources": [ @@ -29821,7 +30838,12 @@ { "title": "Properties", "kind": 1024, - "children": [466, 469, 467, 468] + "children": [ + 466, + 469, + 467, + 468 + ] } ], "sources": [ @@ -30060,7 +31082,11 @@ { "title": "Properties", "kind": 1024, - "children": [478, 479, 480] + "children": [ + 478, + 479, + 480 + ] } ], "sources": [ @@ -30232,7 +31258,11 @@ { "title": "Properties", "kind": 1024, - "children": [488, 489, 490] + "children": [ + 488, + 489, + 490 + ] } ], "sources": [ @@ -30416,7 +31446,11 @@ { "title": "Properties", "kind": 1024, - "children": [497, 498, 500] + "children": [ + 497, + 498, + 500 + ] } ], "sources": [ @@ -30603,7 +31637,11 @@ { "title": "Properties", "kind": 1024, - "children": [497, 498, 500] + "children": [ + 497, + 498, + 500 + ] } ], "sources": [ @@ -30779,7 +31817,11 @@ { "title": "Properties", "kind": 1024, - "children": [478, 479, 480] + "children": [ + 478, + 479, + 480 + ] } ], "sources": [ @@ -30951,7 +31993,11 @@ { "title": "Properties", "kind": 1024, - "children": [488, 489, 490] + "children": [ + 488, + 489, + 490 + ] } ], "sources": [ @@ -31144,7 +32190,12 @@ { "title": "Properties", "kind": 1024, - "children": [509, 507, 508, 510] + "children": [ + 509, + 507, + 508, + 510 + ] } ], "sources": [ @@ -31335,7 +32386,12 @@ { "title": "Properties", "kind": 1024, - "children": [519, 517, 518, 520] + "children": [ + 519, + 517, + 518, + 520 + ] } ], "sources": [ @@ -31514,17 +32570,40 @@ { "title": "Enumerations", "kind": 8, - "children": [535, 539, 544, 548] + "children": [ + 535, + 539, + 544, + 548 + ] }, { "title": "Classes", "kind": 128, - "children": [64, 328, 1] + "children": [ + 64, + 328, + 1 + ] }, { "title": "Type Aliases", "kind": 4194304, - "children": [316, 327, 440, 457, 464, 471, 495, 476, 486, 505, 515, 525, 534] + "children": [ + 316, + 327, + 440, + 457, + 464, + 471, + 495, + 476, + 486, + 505, + 515, + 525, + 534 + ] } ], "sources": [ @@ -31534,4 +32613,4 @@ "character": 0 } ] -} +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/storage.json b/spec/enrichments/tsdoc_v2/storage.json index 79756f23f4a..24cc94a246a 100644 --- a/spec/enrichments/tsdoc_v2/storage.json +++ b/spec/enrichments/tsdoc_v2/storage.json @@ -1,7670 +1,7986 @@ { - "id": 0, - "name": "@supabase/storage-js", - "kind": 1, - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1, - "name": "index", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 442, - "name": "StorageApiError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 443, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 17, - "character": 2 - } - ], - "signatures": [ - { - "id": 444, - "name": "new StorageApiError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 445, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 446, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 442, - "name": "StorageApiError" - }, - "overwrites": { - "type": "reference", - "id": 439, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 438, - "name": "StorageError.constructor" - } - }, - { - "id": 447, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 448, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 23, - "character": 2 - } - ], - "signatures": [ - { - "id": 449, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 450, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 452, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 26, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 451, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 453, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 27, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [452, 451, 453] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [443] - }, - { - "title": "Properties", - "kind": 1024, - "children": [447] - }, - { - "title": "Methods", - "kind": 2048, - "children": [448] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 437, - "name": "StorageError" - } - ] - }, - { - "id": 297, - "name": "StorageClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 298, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 6, - "character": 2 - } - ], - "signatures": [ - { - "id": 299, - "name": "new StorageClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 300, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 301, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 302, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 303, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 304, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 305, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 306, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 307, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 308, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 309, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 297, - "name": "StorageClient" - }, - "overwrites": { - "type": "reference", - "id": 5, - "name": "default.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 4, - "name": "default.constructor" - } - }, - { - "id": 340, - "name": "createBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 85, - "character": 8 - } - ], - "signatures": [ - { - "id": 341, - "name": "createBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id\n" - }, - "parameters": [ - { - "id": 342, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are creating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 343, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 344, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 347, - "name": "allowedMimeTypes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 90, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 346, - "name": "fileSizeLimit", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 89, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 345, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 88, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [347, 346, 345] - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 348, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 349, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 96, - "character": 8 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 392, - "name": "Bucket" - }, - { - "type": "literal", - "value": "name" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 350, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 97, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [349, 350] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 351, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 352, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 100, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 353, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 101, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [352, 353] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 44, - "name": "default.createBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 43, - "name": "default.createBucket" - } - }, - { - "id": 381, - "name": "deleteBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 219, - "character": 8 - } - ], - "signatures": [ - { - "id": 382, - "name": "deleteBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." - }, - "parameters": [ - { - "id": 383, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 384, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 385, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 223, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 387, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 223, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [387] - } - ] - } - } - }, - { - "id": 388, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 224, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [385, 388] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 389, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 390, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 227, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 391, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 228, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [390, 391] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 85, - "name": "default.deleteBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 84, - "name": "default.deleteBucket" - } - }, - { - "id": 370, - "name": "emptyBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 184, - "character": 8 - } - ], - "signatures": [ - { - "id": 371, - "name": "emptyBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes all objects inside a single bucket." - }, - "parameters": [ - { - "id": 372, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 373, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 374, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 376, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 188, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [376] - } - ] - } - } - }, - { - "id": 377, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [374, 377] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 378, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 379, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 192, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 380, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 193, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [379, 380] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 74, - "name": "default.emptyBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 73, - "name": "default.emptyBucket" - } - }, - { - "id": 310, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 15, - "character": 2 - } - ], - "signatures": [ - { - "id": 311, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform file operation in a bucket." - }, - "parameters": [ - { - "id": 312, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The bucket id to operate on.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 96, - "name": "default" - } - } - ] - }, - { - "id": 331, - "name": "getBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 48, - "character": 8 - } - ], - "signatures": [ - { - "id": 332, - "name": "getBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." - }, - "parameters": [ - { - "id": 333, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 334, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 335, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 392, - "name": "Bucket" - } - }, - { - "id": 336, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [335, 336] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 337, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 338, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 56, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 339, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 57, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [338, 339] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 35, - "name": "default.getBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 34, - "name": "default.getBucket" - } - }, - { - "id": 323, - "name": "listBuckets", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 21, - "character": 8 - } - ], - "signatures": [ - { - "id": 324, - "name": "listBuckets", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 325, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 326, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 23, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 392, - "name": "Bucket" - } - } - }, - { - "id": 327, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 24, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [326, 327] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 328, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 329, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 330, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [329, 330] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 27, - "name": "default.listBuckets" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 26, - "name": "default.listBuckets" - } - }, - { - "id": 354, - "name": "updateBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 139, - "character": 8 - } - ], - "signatures": [ - { - "id": 355, - "name": "updateBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates a Storage bucket" - }, - "parameters": [ - { - "id": 356, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are updating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 357, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 358, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 361, - "name": "allowedMimeTypes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 144, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 360, - "name": "fileSizeLimit", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 143, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 359, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 142, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [361, 360, 359] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 362, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 363, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 148, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 364, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 148, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [365] - } - ] - } - } - }, - { - "id": 366, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 149, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [363, 366] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 367, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 152, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 369, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 153, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [368, 369] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 58, - "name": "default.updateBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 57, - "name": "default.updateBucket" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [298] - }, - { - "title": "Methods", - "kind": 2048, - "children": [340, 381, 370, 310, 331, 323, 354] - } - ], - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 5, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 3, - "name": "default" - } - ] - }, - { - "id": 437, - "name": "StorageError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 438, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 2 - } - ], - "signatures": [ - { - "id": 439, - "name": "new StorageError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 440, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [438] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 1, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 442, - "name": "StorageApiError" - }, - { - "type": "reference", - "id": 455, - "name": "StorageUnknownError" - } - ] - }, - { - "id": 455, - "name": "StorageUnknownError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 456, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 35, - "character": 2 - } - ], - "signatures": [ - { - "id": 457, - "name": "new StorageUnknownError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 458, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 459, - "name": "originalError", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 455, - "name": "StorageUnknownError" - }, - "overwrites": { - "type": "reference", - "id": 439, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 438, - "name": "StorageError.constructor" - } - }, - { - "id": 460, - "name": "originalError", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [456] - }, - { - "title": "Properties", - "kind": 1024, - "children": [460] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 32, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 437, - "name": "StorageError" - } - ] - }, - { - "id": 392, - "name": "Bucket", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 397, - "name": "allowed_mime_types", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 6, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 398, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 7, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 396, - "name": "file_size_limit", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 5, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 393, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 2, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 394, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 3, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 395, - "name": "owner", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 4, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 400, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 399, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 8, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [397, 398, 396, 393, 394, 395, 400, 399] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1, - "character": 17 - } - ] - }, - { - "id": 424, - "name": "FetchParameters", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 425, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 74, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [425] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 70, - "character": 17 - } - ] - }, - { - "id": 401, - "name": "FileObject", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 403, - "name": "bucket_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 410, - "name": "buckets", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 392, - "name": "Bucket" - } - }, - { - "id": 407, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 16, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 408, - "name": "last_accessed_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 409, - "name": "metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 20, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 402, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 13, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 404, - "name": "owner", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 406, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [403, 410, 407, 405, 408, 409, 402, 404, 406] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 12, - "character": 17 - } - ] - }, - { - "id": 414, - "name": "FileOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 415, - "name": "cacheControl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 416, - "name": "contentType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 418, - "name": "duplex", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 45, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 417, - "name": "upsert", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [415, 416, 418, 417] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 29, - "character": 17 - } - ] - }, - { - "id": 426, - "name": "Metadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 427, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [427] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 17 - } - ] - }, - { - "id": 419, - "name": "SearchOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 420, - "name": "limit", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": " The number of files you want to be returned." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 52, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 421, - "name": "offset", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The starting position." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 423, - "name": "search", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The search string to filter files by." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 67, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "sortBy", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 411, - "name": "SortBy" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [420, 421, 423, 422] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 17 - } - ] - }, - { - "id": 411, - "name": "SortBy", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 412, - "name": "column", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 413, - "name": "order", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 26, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [412, 413] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 24, - "character": 17 - } - ] - }, - { - "id": 428, - "name": "TransformOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 433, - "name": "format", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "origin" - } - }, - { - "id": 430, - "name": "height", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The height of the image in pixels." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 432, - "name": "quality", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 431, - "name": "resize", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 97, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "cover" - }, - { - "type": "literal", - "value": "contain" - }, - { - "type": "literal", - "value": "fill" - } - ] - } - }, - { - "id": 429, - "name": "width", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The width of the image in pixels." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [433, 430, 432, 431, 429] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 17 - } - ] - }, - { - "id": 434, - "name": "isStorageError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 10, - "character": 16 - } - ], - "signatures": [ - { - "id": 435, - "name": "isStorageError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 436, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [442, 297, 437, 455] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [392, 424, 401, 414, 426, 419, 411, 428] - }, - { - "title": "Functions", - "kind": 64, - "children": [434] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 2, - "name": "packages/StorageBucketApi", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 3, - "name": "default", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 4, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 12, - "character": 2 - } - ], - "signatures": [ - { - "id": 5, - "name": "new default", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 6, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 7, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "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" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 11, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "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": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 3, - "name": "default" - } - } - ] - }, - { - "id": 43, - "name": "createBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 85, - "character": 8 - } - ], - "signatures": [ - { - "id": 44, - "name": "createBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id\n" - }, - "parameters": [ - { - "id": 45, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are creating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 47, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 50, - "name": "allowedMimeTypes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 90, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 49, - "name": "fileSizeLimit", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 89, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 48, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 88, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [50, 49, 48] - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 51, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 52, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 96, - "character": 8 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 392, - "name": "Bucket" - }, - { - "type": "literal", - "value": "name" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 53, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 97, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [52, 53] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 54, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 55, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 100, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 56, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 101, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [55, 56] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 84, - "name": "deleteBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 219, - "character": 8 - } - ], - "signatures": [ - { - "id": 85, - "name": "deleteBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." - }, - "parameters": [ - { - "id": 86, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 88, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 223, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 89, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 90, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 223, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [90] - } - ] - } - } - }, - { - "id": 91, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 224, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [88, 91] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 92, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 93, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 227, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 94, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 228, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [93, 94] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 73, - "name": "emptyBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 184, - "character": 8 - } - ], - "signatures": [ - { - "id": 74, - "name": "emptyBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes all objects inside a single bucket." - }, - "parameters": [ - { - "id": 75, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 77, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 79, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 188, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [79] - } - ] - } - } - }, - { - "id": 80, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [77, 80] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 82, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 192, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 83, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 193, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [82, 83] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 34, - "name": "getBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 48, - "character": 8 - } - ], - "signatures": [ - { - "id": 35, - "name": "getBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." - }, - "parameters": [ - { - "id": 36, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 38, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 392, - "name": "Bucket" - } - }, - { - "id": 39, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [38, 39] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 40, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 41, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 56, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 42, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 57, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [41, 42] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 26, - "name": "listBuckets", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 21, - "character": 8 - } - ], - "signatures": [ - { - "id": 27, - "name": "listBuckets", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 28, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 29, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 23, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 392, - "name": "Bucket" - } - } - }, - { - "id": 30, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 24, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [29, 30] - } - ] - } - }, - { - "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/packages/StorageBucketApi.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 33, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [32, 33] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 57, - "name": "updateBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 139, - "character": 8 - } - ], - "signatures": [ - { - "id": 58, - "name": "updateBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates a Storage bucket" - }, - "parameters": [ - { - "id": 59, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are updating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 60, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 61, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 64, - "name": "allowedMimeTypes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 144, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 63, - "name": "fileSizeLimit", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 143, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 62, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 142, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [64, 63, 62] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 65, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 66, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 148, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 68, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 148, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [68] - } - ] - } - } - }, - { - "id": 69, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 149, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [66, 69] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 70, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 71, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 152, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 72, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 153, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [71, 72] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [4] - }, - { - "title": "Methods", - "kind": 2048, - "children": [43, 84, 73, 34, 26, 57] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 7, - "character": 21 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 297, - "name": "StorageClient" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [3] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 95, - "name": "packages/StorageFileApi", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 96, - "name": "default", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 97, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 45, - "character": 2 - } - ], - "signatures": [ - { - "id": 98, - "name": "new default", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 99, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 100, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 101, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 102, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 103, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 104, - "name": "bucketId", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 105, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 106, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 107, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 108, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 109, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 96, - "name": "default" - } - } - ] - }, - { - "id": 200, - "name": "copy", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 334, - "character": 8 - } - ], - "signatures": [ - { - "id": 201, - "name": "copy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Copies an existing file to a new path in the same bucket." - }, - "parameters": [ - { - "id": 202, - "name": "fromPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 203, - "name": "toPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 204, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 205, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 339, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 206, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 207, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 339, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [207] - } - ] - } - } - }, - { - "id": 208, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 340, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [205, 208] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 209, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 210, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 211, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 344, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [210, 211] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 162, - "name": "createSignedUploadUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 219, - "character": 8 - } - ], - "signatures": [ - { - "id": 163, - "name": "createSignedUploadUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." - }, - "parameters": [ - { - "id": 164, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 223, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 167, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 170, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 223, - "character": 50 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 168, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 223, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 169, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 223, - "character": 35 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [170, 168, 169] - } - ] - } - } - }, - { - "id": 171, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 224, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [166, 171] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 173, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 227, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 174, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 228, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [173, 174] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 212, - "name": "createSignedUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 372, - "character": 8 - } - ], - "signatures": [ - { - "id": 213, - "name": "createSignedUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." - }, - "parameters": [ - { - "id": 214, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 215, - "name": "expiresIn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 216, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 217, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 218, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 375, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - }, - { - "id": 219, - "name": "transform", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Transform the asset before serving it to the client.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 375, - "character": 45 - } - ], - "type": { - "type": "reference", - "id": 428, - "name": "TransformOptions" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [218, 219] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 220, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 221, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 378, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 222, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 223, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 378, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [223] - } - ] - } - } - }, - { - "id": 224, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 379, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [221, 224] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 225, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 226, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 382, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 227, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 383, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [226, 227] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 228, - "name": "createSignedUrls", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 417, - "character": 8 - } - ], - "signatures": [ - { - "id": 229, - "name": "createSignedUrls", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." - }, - "parameters": [ - { - "id": 230, - "name": "paths", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 231, - "name": "expiresIn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 232, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 233, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 234, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 420, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [234] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 235, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 236, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 423, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 237, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 238, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 423, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 239, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 423, - "character": 38 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 240, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 423, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [238, 239, 240] - } - ] - } - } - } - }, - { - "id": 241, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 424, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [236, 241] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 242, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 243, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 427, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 244, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 428, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [243, 244] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 245, - "name": "download", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 466, - "character": 8 - } - ], - "signatures": [ - { - "id": 246, - "name": "download", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead." - }, - "parameters": [ - { - "id": 247, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 248, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 249, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 250, - "name": "transform", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Transform the asset before serving it to the client.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 468, - "character": 16 - } - ], - "type": { - "type": "reference", - "id": 428, - "name": "TransformOptions" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [250] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 251, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 252, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 471, - "character": 8 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - } - }, - { - "id": 253, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 472, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [252, 253] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 254, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 255, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 475, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 256, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 476, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [255, 256] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 257, - "name": "getPublicUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 509, - "character": 2 - } - ], - "signatures": [ - { - "id": 258, - "name": "getPublicUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." - }, - "parameters": [ - { - "id": 259, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 260, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 262, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 511, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - }, - { - "id": 263, - "name": "transform", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Transform the asset before serving it to the client.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 511, - "character": 45 - } - ], - "type": { - "type": "reference", - "id": 428, - "name": "TransformOptions" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [262, 263] - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 264, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 265, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 512, - "character": 7 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 266, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 267, - "name": "publicUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 512, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [267] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [265] - } - ] - } - } - } - ] - }, - { - "id": 277, - "name": "list", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 643, - "character": 8 - } - ], - "signatures": [ - { - "id": 278, - "name": "list", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Lists all the files within a bucket." - }, - "parameters": [ - { - "id": 279, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The folder path.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 280, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 419, - "name": "SearchOptions" - } - }, - { - "id": 281, - "name": "parameters", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 424, - "name": "FetchParameters" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 282, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 283, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 649, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 401, - "name": "FileObject" - } - } - }, - { - "id": 284, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 650, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [283, 284] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 285, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 286, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 653, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 287, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 654, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [286, 287] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 188, - "name": "move", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 298, - "character": 8 - } - ], - "signatures": [ - { - "id": 189, - "name": "move", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Moves an existing file to a new path in the same bucket." - }, - "parameters": [ - { - "id": 190, - "name": "fromPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 191, - "name": "toPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-new.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 193, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 303, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 195, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 303, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [195] - } - ] - } - } - }, - { - "id": 196, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 304, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [193, 196] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 197, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 198, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 307, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 199, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 308, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [198, 199] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 268, - "name": "remove", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 547, - "character": 8 - } - ], - "signatures": [ - { - "id": 269, - "name": "remove", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes files within the same bucket" - }, - "parameters": [ - { - "id": 270, - "name": "paths", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 271, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 272, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 551, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 401, - "name": "FileObject" - } - } - }, - { - "id": 273, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 552, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [272, 273] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 275, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 555, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 276, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 556, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [275, 276] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 175, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 265, - "character": 8 - } - ], - "signatures": [ - { - "id": 176, - "name": "update", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Replaces an existing file at the specified path with a new one." - }, - "parameters": [ - { - "id": 177, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 178, - "name": "fileBody", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" - }, - { - "type": "reference", - "qualifiedName": "ArrayBufferView", - "package": "typescript", - "name": "ArrayBufferView" - }, - { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - }, - { - "type": "reference", - "qualifiedName": "Buffer", - "package": "@types/node", - "name": "Buffer" - }, - { - "type": "reference", - "qualifiedName": "File", - "package": "typescript", - "name": "File" - }, - { - "type": "reference", - "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" - }, - { - "type": "reference", - "qualifiedName": "NodeJS.ReadableStream", - "package": "@types/node", - "name": "ReadableStream" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - ], - "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" - }, - { - "type": "reference", - "qualifiedName": "URLSearchParams", - "package": "typescript", - "name": "URLSearchParams" - } - ] - } - }, - { - "id": 179, - "name": "fileOptions", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 414, - "name": "FileOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 181, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 281, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 182, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 183, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 281, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [183] - } - ] - } - } - }, - { - "id": 184, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 282, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [181, 184] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 185, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 186, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 285, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 187, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [186, 187] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, - "name": "upload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 133, - "character": 8 - } - ], - "signatures": [ - { - "id": 136, - "name": "upload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Uploads a file to an existing bucket." - }, - "parameters": [ - { - "id": 137, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 138, - "name": "fileBody", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" - }, - "type": { - "type": "reference", - "name": "FileBody" - } - }, - { - "id": 139, - "name": "fileOptions", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 414, - "name": "FileOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 141, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 139, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 142, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 143, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 139, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [143] - } - ] - } - } - }, - { - "id": 144, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 140, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [141, 144] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 145, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 146, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 143, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 147, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 144, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [146, 147] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 148, - "name": "uploadToSignedUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 156, - "character": 8 - } - ], - "signatures": [ - { - "id": 149, - "name": "uploadToSignedUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Upload a file with a token generated from `createSignedUploadUrl`." - }, - "parameters": [ - { - "id": 150, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 151, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The token generated from `createSignedUploadUrl`" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 152, - "name": "fileBody", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" - }, - "type": { - "type": "reference", - "name": "FileBody" - } - }, - { - "id": 153, - "name": "fileOptions", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 414, - "name": "FileOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 154, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 155, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 197, - "character": 10 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 156, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 157, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 197, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "cleanPath" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [157] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 158, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 198, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [155, 158] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 160, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 202, - "character": 17 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - }, - { - "id": 161, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [160, 161] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [97] - }, - { - "title": "Methods", - "kind": 2048, - "children": [200, 162, 212, 228, 245, 257, 277, 188, 268, 175, 135, 148] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 39, - "character": 21 - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [96] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 1, - "character": 0 - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "kind": 2, - "children": [1, 2, 95] - } - ] -} + "id": 0, + "name": "@supabase/storage-js", + "kind": 1, + "flags": {}, + "originalName": "", + "children": [ + { + "id": 1, + "name": "index", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 442, + "name": "StorageApiError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 443, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 17, + "character": 2 + } + ], + "signatures": [ + { + "id": 444, + "name": "new StorageApiError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 445, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 442, + "name": "StorageApiError" + }, + "overwrites": { + "type": "reference", + "id": 439, + "name": "StorageError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 438, + "name": "StorageError.constructor" + } + }, + { + "id": 447, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 15, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 448, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 23, + "character": 2 + } + ], + "signatures": [ + { + "id": 449, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 450, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 452, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 26, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 451, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 25, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 453, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 27, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 452, + 451, + 453 + ] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 443 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 447 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 448 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 437, + "name": "StorageError" + } + ] + }, + { + "id": 297, + "name": "StorageClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 298, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 6, + "character": 2 + } + ], + "signatures": [ + { + "id": 299, + "name": "new StorageClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 300, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 301, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 302, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 303, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 304, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 305, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 306, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 307, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 308, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 309, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 297, + "name": "StorageClient" + }, + "overwrites": { + "type": "reference", + "id": 5, + "name": "default.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 4, + "name": "default.constructor" + } + }, + { + "id": 340, + "name": "createBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 85, + "character": 8 + } + ], + "signatures": [ + { + "id": 341, + "name": "createBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new Storage bucket", + "returns": "newly created bucket id\n" + }, + "parameters": [ + { + "id": 342, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A unique identifier for the bucket you are creating." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 343, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 344, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 347, + "name": "allowedMimeTypes", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 90, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 346, + "name": "fileSizeLimit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 89, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 345, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 88, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 347, + 346, + 345 + ] + } + ] + } + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 348, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 349, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 96, + "character": 8 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 392, + "name": "Bucket" + }, + { + "type": "literal", + "value": "name" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 350, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 97, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 349, + 350 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 351, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 352, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 100, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 353, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 101, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 352, + 353 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 44, + "name": "default.createBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 43, + "name": "default.createBucket" + } + }, + { + "id": 381, + "name": "deleteBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 219, + "character": 8 + } + ], + "signatures": [ + { + "id": 382, + "name": "deleteBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + }, + "parameters": [ + { + "id": 383, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to delete.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 384, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 385, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 223, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 386, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 387, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 223, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 387 + ] + } + ] + } + } + }, + { + "id": 388, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 224, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 385, + 388 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 389, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 390, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 227, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 391, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 228, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 390, + 391 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 85, + "name": "default.deleteBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 84, + "name": "default.deleteBucket" + } + }, + { + "id": 370, + "name": "emptyBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 184, + "character": 8 + } + ], + "signatures": [ + { + "id": 371, + "name": "emptyBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Removes all objects inside a single bucket." + }, + "parameters": [ + { + "id": 372, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to empty.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 373, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 374, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 188, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 375, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 376, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 188, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 376 + ] + } + ] + } + } + }, + { + "id": 377, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 189, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 374, + 377 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 378, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 379, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 192, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 380, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 193, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 379, + 380 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 74, + "name": "default.emptyBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 73, + "name": "default.emptyBucket" + } + }, + { + "id": 310, + "name": "from", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 15, + "character": 2 + } + ], + "signatures": [ + { + "id": 311, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform file operation in a bucket." + }, + "parameters": [ + { + "id": 312, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The bucket id to operate on.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 96, + "name": "default" + } + } + ] + }, + { + "id": 331, + "name": "getBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 8 + } + ], + "signatures": [ + { + "id": 332, + "name": "getBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of an existing Storage bucket." + }, + "parameters": [ + { + "id": 333, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 334, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 335, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 392, + "name": "Bucket" + } + }, + { + "id": 336, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 53, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 335, + 336 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 337, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 338, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 56, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 339, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 57, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 338, + 339 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 35, + "name": "default.getBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 34, + "name": "default.getBucket" + } + }, + { + "id": 323, + "name": "listBuckets", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 21, + "character": 8 + } + ], + "signatures": [ + { + "id": 324, + "name": "listBuckets", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of all Storage buckets within an existing project." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 325, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 326, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 23, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 392, + "name": "Bucket" + } + } + }, + { + "id": 327, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 24, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 326, + 327 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 328, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 329, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 27, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 330, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 28, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 329, + 330 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 27, + "name": "default.listBuckets" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 26, + "name": "default.listBuckets" + } + }, + { + "id": 354, + "name": "updateBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 139, + "character": 8 + } + ], + "signatures": [ + { + "id": 355, + "name": "updateBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates a Storage bucket" + }, + "parameters": [ + { + "id": 356, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A unique identifier for the bucket you are updating." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 357, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 358, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 361, + "name": "allowedMimeTypes", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 144, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 360, + "name": "fileSizeLimit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 143, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 359, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 142, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 361, + 360, + 359 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 362, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 363, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 148, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 364, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 365, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 148, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 365 + ] + } + ] + } + } + }, + { + "id": 366, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 149, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 363, + 366 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 367, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 368, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 152, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 369, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 153, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 368, + 369 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 58, + "name": "default.updateBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 57, + "name": "default.updateBucket" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 298 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 340, + 381, + 370, + 310, + 331, + 323, + 354 + ] + } + ], + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 5, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 3, + "name": "default" + } + ] + }, + { + "id": 437, + "name": "StorageError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 438, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 4, + "character": 2 + } + ], + "signatures": [ + { + "id": 439, + "name": "new StorageError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 440, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 438 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 1, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 442, + "name": "StorageApiError" + }, + { + "type": "reference", + "id": 455, + "name": "StorageUnknownError" + } + ] + }, + { + "id": 455, + "name": "StorageUnknownError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 456, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 35, + "character": 2 + } + ], + "signatures": [ + { + "id": 457, + "name": "new StorageUnknownError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 458, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 459, + "name": "originalError", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 455, + "name": "StorageUnknownError" + }, + "overwrites": { + "type": "reference", + "id": 439, + "name": "StorageError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 438, + "name": "StorageError.constructor" + } + }, + { + "id": 460, + "name": "originalError", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 456 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 460 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 32, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 437, + "name": "StorageError" + } + ] + }, + { + "id": 392, + "name": "Bucket", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 397, + "name": "allowed_mime_types", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 6, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 398, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 396, + "name": "file_size_limit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 5, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 393, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 2, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 394, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 3, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "owner", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 4, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 400, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 399, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 8, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 397, + 398, + 396, + 393, + 394, + 395, + 400, + 399 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1, + "character": 17 + } + ] + }, + { + "id": 424, + "name": "FetchParameters", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 425, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Pass in an AbortController's signal to cancel the request." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 425 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 17 + } + ] + }, + { + "id": 401, + "name": "FileObject", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 403, + "name": "bucket_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 410, + "name": "buckets", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 21, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 392, + "name": "Bucket" + } + }, + { + "id": 407, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 405, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 16, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 408, + "name": "last_accessed_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 19, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 409, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 402, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 13, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 404, + "name": "owner", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 15, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 406, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 17, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 403, + 410, + 407, + 405, + 408, + 409, + 402, + 404, + 406 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 17 + } + ] + }, + { + "id": 414, + "name": "FileOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 415, + "name": "cacheControl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 416, + "name": "contentType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 418, + "name": "duplex", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 417, + "name": "upsert", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 415, + 416, + 418, + 417 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 29, + "character": 17 + } + ] + }, + { + "id": 426, + "name": "Metadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 427, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 79, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 427 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 17 + } + ] + }, + { + "id": 419, + "name": "SearchOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 420, + "name": "limit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": " The number of files you want to be returned." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 421, + "name": "offset", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The starting position." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 423, + "name": "search", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The search string to filter files by." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 422, + "name": "sortBy", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The column to sort by. Can be any column inside a FileObject." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 411, + "name": "SortBy" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 420, + 421, + 423, + 422 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 17 + } + ] + }, + { + "id": 411, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 412, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 25, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 413, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 26, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 412, + 413 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 24, + "character": 17 + } + ] + }, + { + "id": 428, + "name": "TransformOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 433, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Specify the format of the image requested.", + "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "origin" + } + }, + { + "id": 430, + "name": "height", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The height of the image in pixels." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 432, + "name": "quality", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 103, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 431, + "name": "resize", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 97, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "cover" + }, + { + "type": "literal", + "value": "contain" + }, + { + "type": "literal", + "value": "fill" + } + ] + } + }, + { + "id": 429, + "name": "width", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The width of the image in pixels." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 433, + 430, + 432, + 431, + 429 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 82, + "character": 17 + } + ] + }, + { + "id": 434, + "name": "isStorageError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 10, + "character": 16 + } + ], + "signatures": [ + { + "id": 435, + "name": "isStorageError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 436, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [ + 442, + 297, + 437, + 455 + ] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [ + 392, + 424, + 401, + 414, + 426, + 419, + 411, + 428 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [ + 434 + ] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 2, + "name": "packages/StorageBucketApi", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 3, + "name": "default", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 4, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 12, + "character": 2 + } + ], + "signatures": [ + { + "id": 5, + "name": "new default", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 6, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 7, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "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" + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 11, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "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": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 3, + "name": "default" + } + } + ] + }, + { + "id": 43, + "name": "createBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 85, + "character": 8 + } + ], + "signatures": [ + { + "id": 44, + "name": "createBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new Storage bucket", + "returns": "newly created bucket id\n" + }, + "parameters": [ + { + "id": 45, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A unique identifier for the bucket you are creating." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 46, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 47, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 50, + "name": "allowedMimeTypes", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 90, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 49, + "name": "fileSizeLimit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 89, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 48, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 88, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 50, + 49, + 48 + ] + } + ] + } + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 51, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 52, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 96, + "character": 8 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 392, + "name": "Bucket" + }, + { + "type": "literal", + "value": "name" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 53, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 97, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 52, + 53 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 54, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 55, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 100, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 56, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 101, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 55, + 56 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 84, + "name": "deleteBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 219, + "character": 8 + } + ], + "signatures": [ + { + "id": 85, + "name": "deleteBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + }, + "parameters": [ + { + "id": 86, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to delete.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 87, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 88, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 223, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 89, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 90, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 223, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 90 + ] + } + ] + } + } + }, + { + "id": 91, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 224, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 88, + 91 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 92, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 93, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 227, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 94, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 228, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 93, + 94 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 73, + "name": "emptyBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 184, + "character": 8 + } + ], + "signatures": [ + { + "id": 74, + "name": "emptyBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Removes all objects inside a single bucket." + }, + "parameters": [ + { + "id": 75, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to empty.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 76, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 77, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 188, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 78, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 79, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 188, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 79 + ] + } + ] + } + } + }, + { + "id": 80, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 189, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 77, + 80 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 81, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 82, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 192, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 83, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 193, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 82, + 83 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 34, + "name": "getBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 8 + } + ], + "signatures": [ + { + "id": 35, + "name": "getBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of an existing Storage bucket." + }, + "parameters": [ + { + "id": 36, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 37, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 38, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 392, + "name": "Bucket" + } + }, + { + "id": 39, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 53, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 38, + 39 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 40, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 41, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 56, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 42, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 57, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 41, + 42 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 26, + "name": "listBuckets", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 21, + "character": 8 + } + ], + "signatures": [ + { + "id": 27, + "name": "listBuckets", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of all Storage buckets within an existing project." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 28, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 29, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 23, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 392, + "name": "Bucket" + } + } + }, + { + "id": 30, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 24, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 29, + 30 + ] + } + ] + } + }, + { + "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/packages/StorageBucketApi.ts", + "line": 27, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 33, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 28, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 32, + 33 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 57, + "name": "updateBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 139, + "character": 8 + } + ], + "signatures": [ + { + "id": 58, + "name": "updateBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates a Storage bucket" + }, + "parameters": [ + { + "id": 59, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A unique identifier for the bucket you are updating." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 60, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 61, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 64, + "name": "allowedMimeTypes", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 144, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 63, + "name": "fileSizeLimit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 143, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 62, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 142, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 64, + 63, + 62 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 65, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 66, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 148, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 67, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 68, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 148, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 68 + ] + } + ] + } + } + }, + { + "id": 69, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 149, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 66, + 69 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 70, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 71, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 152, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 72, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 153, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 71, + 72 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 4 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 43, + 84, + 73, + 34, + 26, + 57 + ] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 7, + "character": 21 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 297, + "name": "StorageClient" + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [ + 3 + ] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 95, + "name": "packages/StorageFileApi", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 96, + "name": "default", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 97, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 45, + "character": 2 + } + ], + "signatures": [ + { + "id": 98, + "name": "new default", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 99, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 100, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 101, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 102, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 103, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 104, + "name": "bucketId", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 105, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 108, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 109, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 96, + "name": "default" + } + } + ] + }, + { + "id": 200, + "name": "copy", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 334, + "character": 8 + } + ], + "signatures": [ + { + "id": 201, + "name": "copy", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Copies an existing file to a new path in the same bucket." + }, + "parameters": [ + { + "id": 202, + "name": "fromPath", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The original file path, including the current file name. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 203, + "name": "toPath", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 204, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 205, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 339, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 206, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 207, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 339, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 207 + ] + } + ] + } + } + }, + { + "id": 208, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 340, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 205, + 208 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 209, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 210, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 343, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 211, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 344, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 210, + 211 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 162, + "name": "createSignedUploadUrl", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 219, + "character": 8 + } + ], + "signatures": [ + { + "id": 163, + "name": "createSignedUploadUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." + }, + "parameters": [ + { + "id": 164, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The file path, including the current file name. For example `folder/image.png`.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 165, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 166, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 223, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 167, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 170, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 223, + "character": 50 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 168, + "name": "signedUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 223, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 169, + "name": "token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 223, + "character": 35 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 170, + 168, + 169 + ] + } + ] + } + } + }, + { + "id": 171, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 224, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 166, + 171 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 172, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 173, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 227, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 174, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 228, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 173, + 174 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 212, + "name": "createSignedUrl", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 372, + "character": 8 + } + ], + "signatures": [ + { + "id": 213, + "name": "createSignedUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." + }, + "parameters": [ + { + "id": 214, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The file path, including the current file name. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 215, + "name": "expiresIn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 216, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 217, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 218, + "name": "download", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 375, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + }, + { + "id": 219, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 375, + "character": 45 + } + ], + "type": { + "type": "reference", + "id": 428, + "name": "TransformOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 218, + 219 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 220, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 221, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 378, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 222, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 223, + "name": "signedUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 378, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 223 + ] + } + ] + } + } + }, + { + "id": 224, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 379, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 221, + 224 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 225, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 226, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 382, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 227, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 383, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 226, + 227 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 228, + "name": "createSignedUrls", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 417, + "character": 8 + } + ], + "signatures": [ + { + "id": 229, + "name": "createSignedUrls", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." + }, + "parameters": [ + { + "id": 230, + "name": "paths", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 231, + "name": "expiresIn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 232, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 233, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 234, + "name": "download", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 420, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 234 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 235, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 236, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 423, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 237, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 238, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 423, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 239, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 423, + "character": 38 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 240, + "name": "signedUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 423, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 238, + 239, + 240 + ] + } + ] + } + } + } + }, + { + "id": 241, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 424, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 236, + 241 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 242, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 243, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 427, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 244, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 428, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 243, + 244 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 245, + "name": "download", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 466, + "character": 8 + } + ], + "signatures": [ + { + "id": 246, + "name": "download", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead." + }, + "parameters": [ + { + "id": 247, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 248, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 249, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 250, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 468, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 428, + "name": "TransformOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 250 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 251, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 252, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 471, + "character": 8 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Blob", + "package": "typescript", + "name": "Blob" + } + }, + { + "id": 253, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 472, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 252, + 253 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 254, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 255, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 475, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 256, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 476, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 255, + 256 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 257, + "name": "getPublicUrl", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 509, + "character": 2 + } + ], + "signatures": [ + { + "id": 258, + "name": "getPublicUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." + }, + "parameters": [ + { + "id": 259, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 260, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 261, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 262, + "name": "download", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 511, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + }, + { + "id": 263, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 511, + "character": 45 + } + ], + "type": { + "type": "reference", + "id": 428, + "name": "TransformOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 262, + 263 + ] + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 264, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 265, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 512, + "character": 7 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 266, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 267, + "name": "publicUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 512, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 267 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 265 + ] + } + ] + } + } + } + ] + }, + { + "id": 277, + "name": "list", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 643, + "character": 8 + } + ], + "signatures": [ + { + "id": 278, + "name": "list", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Lists all the files within a bucket." + }, + "parameters": [ + { + "id": 279, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The folder path.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 280, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 419, + "name": "SearchOptions" + } + }, + { + "id": 281, + "name": "parameters", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 424, + "name": "FetchParameters" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 282, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 283, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 649, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 401, + "name": "FileObject" + } + } + }, + { + "id": 284, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 650, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 283, + 284 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 285, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 286, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 653, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 287, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 654, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 286, + 287 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 188, + "name": "move", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 298, + "character": 8 + } + ], + "signatures": [ + { + "id": 189, + "name": "move", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Moves an existing file to a new path in the same bucket." + }, + "parameters": [ + { + "id": 190, + "name": "fromPath", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The original file path, including the current file name. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 191, + "name": "toPath", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The new file path, including the new file name. For example `folder/image-new.png`.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 192, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 193, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 303, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 194, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 195, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 303, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 195 + ] + } + ] + } + } + }, + { + "id": 196, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 304, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 193, + 196 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 197, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 198, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 307, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 199, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 308, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 198, + 199 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 268, + "name": "remove", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 547, + "character": 8 + } + ], + "signatures": [ + { + "id": 269, + "name": "remove", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Deletes files within the same bucket" + }, + "parameters": [ + { + "id": 270, + "name": "paths", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 271, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 272, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 551, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 401, + "name": "FileObject" + } + } + }, + { + "id": 273, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 552, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 272, + 273 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 274, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 275, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 555, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 276, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 556, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 275, + 276 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 175, + "name": "update", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 265, + "character": 8 + } + ], + "signatures": [ + { + "id": 176, + "name": "update", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Replaces an existing file at the specified path with a new one." + }, + "parameters": [ + { + "id": 177, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 178, + "name": "fileBody", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The body of the file to be stored in the bucket.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "ArrayBuffer", + "package": "typescript", + "name": "ArrayBuffer" + }, + { + "type": "reference", + "qualifiedName": "ArrayBufferView", + "package": "typescript", + "name": "ArrayBufferView" + }, + { + "type": "reference", + "qualifiedName": "Blob", + "package": "typescript", + "name": "Blob" + }, + { + "type": "reference", + "qualifiedName": "Buffer", + "package": "@types/node", + "name": "Buffer" + }, + { + "type": "reference", + "qualifiedName": "File", + "package": "typescript", + "name": "File" + }, + { + "type": "reference", + "qualifiedName": "FormData", + "package": "typescript", + "name": "FormData" + }, + { + "type": "reference", + "qualifiedName": "NodeJS.ReadableStream", + "package": "@types/node", + "name": "ReadableStream" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Uint8Array", + "package": "typescript", + "name": "Uint8Array" + } + ], + "qualifiedName": "ReadableStream", + "package": "typescript", + "name": "ReadableStream" + }, + { + "type": "reference", + "qualifiedName": "URLSearchParams", + "package": "typescript", + "name": "URLSearchParams" + } + ] + } + }, + { + "id": 179, + "name": "fileOptions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 414, + "name": "FileOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 180, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 181, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 281, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 182, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 183, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 281, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 183 + ] + } + ] + } + } + }, + { + "id": 184, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 282, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 181, + 184 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 185, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 186, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 285, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 187, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 286, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 186, + 187 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 135, + "name": "upload", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 133, + "character": 8 + } + ], + "signatures": [ + { + "id": 136, + "name": "upload", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Uploads a file to an existing bucket." + }, + "parameters": [ + { + "id": 137, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 138, + "name": "fileBody", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The body of the file to be stored in the bucket.\n" + }, + "type": { + "type": "reference", + "name": "FileBody" + } + }, + { + "id": 139, + "name": "fileOptions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 414, + "name": "FileOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 140, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 141, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 139, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 142, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 143, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 139, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 143 + ] + } + ] + } + } + }, + { + "id": 144, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 140, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 141, + 144 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 145, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 146, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 143, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 147, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 144, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 437, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 146, + 147 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 148, + "name": "uploadToSignedUrl", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 156, + "character": 8 + } + ], + "signatures": [ + { + "id": 149, + "name": "uploadToSignedUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Upload a file with a token generated from `createSignedUploadUrl`." + }, + "parameters": [ + { + "id": 150, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 151, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The token generated from `createSignedUploadUrl`" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 152, + "name": "fileBody", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The body of the file to be stored in the bucket.\n" + }, + "type": { + "type": "reference", + "name": "FileBody" + } + }, + { + "id": 153, + "name": "fileOptions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 414, + "name": "FileOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 154, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 155, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 197, + "character": 10 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 156, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 157, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 197, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "cleanPath" + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 157 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 158, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 198, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + }, + "defaultValue": "null" + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 155, + 158 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 159, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 160, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 202, + "character": 17 + } + ], + "type": { + "type": "literal", + "value": null + }, + "defaultValue": "null" + }, + { + "id": 161, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 160, + 161 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 97 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 200, + 162, + 212, + 228, + 245, + 257, + 277, + 188, + 268, + 175, + 135, + 148 + ] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 39, + "character": 21 + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [ + 96 + ] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "kind": 2, + "children": [ + 1, + 2, + 95 + ] + } + ] +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/storage_dereferenced.json b/spec/enrichments/tsdoc_v2/storage_dereferenced.json index 82ee225ed96..a056a4da26a 100644 --- a/spec/enrichments/tsdoc_v2/storage_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/storage_dereferenced.json @@ -190,7 +190,11 @@ { "title": "Properties", "kind": 1024, - "children": [452, 451, 453] + "children": [ + 452, + 451, + 453 + ] } ] } @@ -203,17 +207,23 @@ { "title": "Constructors", "kind": 512, - "children": [443] + "children": [ + 443 + ] }, { "title": "Properties", "kind": 1024, - "children": [447] + "children": [ + 447 + ] }, { "title": "Methods", "kind": 2048, - "children": [448] + "children": [ + 448 + ] } ], "sources": [ @@ -553,7 +563,11 @@ { "title": "Properties", "kind": 1024, - "children": [347, 346, 345] + "children": [ + 347, + 346, + 345 + ] } ] } @@ -630,7 +644,10 @@ { "title": "Properties", "kind": 1024, - "children": [349, 350] + "children": [ + 349, + 350 + ] } ] } @@ -686,7 +703,10 @@ { "title": "Properties", "kind": 1024, - "children": [352, 353] + "children": [ + 352, + 353 + ] } ] } @@ -810,7 +830,9 @@ { "title": "Properties", "kind": 1024, - "children": [387] + "children": [ + 387 + ] } ] } @@ -839,7 +861,10 @@ { "title": "Properties", "kind": 1024, - "children": [385, 388] + "children": [ + 385, + 388 + ] } ] } @@ -895,7 +920,10 @@ { "title": "Properties", "kind": 1024, - "children": [390, 391] + "children": [ + 390, + 391 + ] } ] } @@ -1019,7 +1047,9 @@ { "title": "Properties", "kind": 1024, - "children": [376] + "children": [ + 376 + ] } ] } @@ -1048,7 +1078,10 @@ { "title": "Properties", "kind": 1024, - "children": [374, 377] + "children": [ + 374, + 377 + ] } ] } @@ -1104,7 +1137,10 @@ { "title": "Properties", "kind": 1024, - "children": [379, 380] + "children": [ + 379, + 380 + ] } ] } @@ -1272,7 +1308,10 @@ { "title": "Properties", "kind": 1024, - "children": [335, 336] + "children": [ + 335, + 336 + ] } ] } @@ -1328,7 +1367,10 @@ { "title": "Properties", "kind": 1024, - "children": [338, 339] + "children": [ + 338, + 339 + ] } ] } @@ -1436,7 +1478,10 @@ { "title": "Properties", "kind": 1024, - "children": [326, 327] + "children": [ + 326, + 327 + ] } ] } @@ -1492,7 +1537,10 @@ { "title": "Properties", "kind": 1024, - "children": [329, 330] + "children": [ + 329, + 330 + ] } ] } @@ -1667,7 +1715,11 @@ { "title": "Properties", "kind": 1024, - "children": [361, 360, 359] + "children": [ + 361, + 360, + 359 + ] } ] } @@ -1734,7 +1786,9 @@ { "title": "Properties", "kind": 1024, - "children": [365] + "children": [ + 365 + ] } ] } @@ -1763,7 +1817,10 @@ { "title": "Properties", "kind": 1024, - "children": [363, 366] + "children": [ + 363, + 366 + ] } ] } @@ -1819,7 +1876,10 @@ { "title": "Properties", "kind": 1024, - "children": [368, 369] + "children": [ + 368, + 369 + ] } ] } @@ -1849,12 +1909,22 @@ { "title": "Constructors", "kind": 512, - "children": [298] + "children": [ + 298 + ] }, { "title": "Methods", "kind": 2048, - "children": [340, 381, 370, 310, 331, 323, 354] + "children": [ + 340, + 381, + 370, + 310, + 331, + 323, + 354 + ] } ], "sources": [ @@ -1933,7 +2003,9 @@ { "title": "Constructors", "kind": 512, - "children": [438] + "children": [ + 438 + ] } ], "sources": [ @@ -2056,12 +2128,16 @@ { "title": "Constructors", "kind": 512, - "children": [456] + "children": [ + 456 + ] }, { "title": "Properties", "kind": 1024, - "children": [460] + "children": [ + 460 + ] } ], "sources": [ @@ -2242,7 +2318,16 @@ { "title": "Properties", "kind": 1024, - "children": [397, 398, 396, 393, 394, 395, 400, 399] + "children": [ + 397, + 398, + 396, + 393, + 394, + 395, + 400, + 399 + ] } ], "sources": [ @@ -2290,7 +2375,9 @@ { "title": "Properties", "kind": 1024, - "children": [425] + "children": [ + 425 + ] } ], "sources": [ @@ -2506,7 +2593,16 @@ { "title": "Properties", "kind": 1024, - "children": [397, 398, 396, 393, 394, 395, 400, 399] + "children": [ + 397, + 398, + 396, + 393, + 394, + 395, + 400, + 399 + ] } ], "sources": [ @@ -2662,7 +2758,17 @@ { "title": "Properties", "kind": 1024, - "children": [403, 410, 407, 405, 408, 409, 402, 404, 406] + "children": [ + 403, + 410, + 407, + 405, + 408, + 409, + 402, + 404, + 406 + ] } ], "sources": [ @@ -2777,7 +2883,12 @@ { "title": "Properties", "kind": 1024, - "children": [415, 416, 418, 417] + "children": [ + 415, + 416, + 418, + 417 + ] } ], "sources": [ @@ -2818,7 +2929,9 @@ { "title": "Properties", "kind": 1024, - "children": [427] + "children": [ + 427 + ] } ], "sources": [ @@ -2979,7 +3092,10 @@ { "title": "Properties", "kind": 1024, - "children": [412, 413] + "children": [ + 412, + 413 + ] } ], "sources": [ @@ -2997,7 +3113,12 @@ { "title": "Properties", "kind": 1024, - "children": [420, 421, 423, 422] + "children": [ + 420, + 421, + 423, + 422 + ] } ], "sources": [ @@ -3060,7 +3181,10 @@ { "title": "Properties", "kind": 1024, - "children": [412, 413] + "children": [ + 412, + 413 + ] } ], "sources": [ @@ -3212,7 +3336,13 @@ { "title": "Properties", "kind": 1024, - "children": [433, 430, 432, 431, 429] + "children": [ + 433, + 430, + 432, + 431, + 429 + ] } ], "sources": [ @@ -3274,17 +3404,33 @@ { "title": "Classes", "kind": 128, - "children": [442, 297, 437, 455] + "children": [ + 442, + 297, + 437, + 455 + ] }, { "title": "Interfaces", "kind": 256, - "children": [392, 424, 401, 414, 426, 419, 411, 428] + "children": [ + 392, + 424, + 401, + 414, + 426, + 419, + 411, + 428 + ] }, { "title": "Functions", "kind": 64, - "children": [434] + "children": [ + 434 + ] } ], "sources": [ @@ -3614,7 +3760,11 @@ { "title": "Properties", "kind": 1024, - "children": [50, 49, 48] + "children": [ + 50, + 49, + 48 + ] } ] } @@ -3691,7 +3841,10 @@ { "title": "Properties", "kind": 1024, - "children": [52, 53] + "children": [ + 52, + 53 + ] } ] } @@ -3747,7 +3900,10 @@ { "title": "Properties", "kind": 1024, - "children": [55, 56] + "children": [ + 55, + 56 + ] } ] } @@ -3861,7 +4017,9 @@ { "title": "Properties", "kind": 1024, - "children": [90] + "children": [ + 90 + ] } ] } @@ -3890,7 +4048,10 @@ { "title": "Properties", "kind": 1024, - "children": [88, 91] + "children": [ + 88, + 91 + ] } ] } @@ -3946,7 +4107,10 @@ { "title": "Properties", "kind": 1024, - "children": [93, 94] + "children": [ + 93, + 94 + ] } ] } @@ -4060,7 +4224,9 @@ { "title": "Properties", "kind": 1024, - "children": [79] + "children": [ + 79 + ] } ] } @@ -4089,7 +4255,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 80] + "children": [ + 77, + 80 + ] } ] } @@ -4145,7 +4314,10 @@ { "title": "Properties", "kind": 1024, - "children": [82, 83] + "children": [ + 82, + 83 + ] } ] } @@ -4256,7 +4428,10 @@ { "title": "Properties", "kind": 1024, - "children": [38, 39] + "children": [ + 38, + 39 + ] } ] } @@ -4312,7 +4487,10 @@ { "title": "Properties", "kind": 1024, - "children": [41, 42] + "children": [ + 41, + 42 + ] } ] } @@ -4410,7 +4588,10 @@ { "title": "Properties", "kind": 1024, - "children": [29, 30] + "children": [ + 29, + 30 + ] } ] } @@ -4466,7 +4647,10 @@ { "title": "Properties", "kind": 1024, - "children": [32, 33] + "children": [ + 32, + 33 + ] } ] } @@ -4631,7 +4815,11 @@ { "title": "Properties", "kind": 1024, - "children": [64, 63, 62] + "children": [ + 64, + 63, + 62 + ] } ] } @@ -4698,7 +4886,9 @@ { "title": "Properties", "kind": 1024, - "children": [68] + "children": [ + 68 + ] } ] } @@ -4727,7 +4917,10 @@ { "title": "Properties", "kind": 1024, - "children": [66, 69] + "children": [ + 66, + 69 + ] } ] } @@ -4783,7 +4976,10 @@ { "title": "Properties", "kind": 1024, - "children": [71, 72] + "children": [ + 71, + 72 + ] } ] } @@ -4803,12 +4999,21 @@ { "title": "Constructors", "kind": 512, - "children": [4] + "children": [ + 4 + ] }, { "title": "Methods", "kind": 2048, - "children": [43, 84, 73, 34, 26, 57] + "children": [ + 43, + 84, + 73, + 34, + 26, + 57 + ] } ], "sources": [ @@ -4831,7 +5036,9 @@ { "title": "Classes", "kind": 128, - "children": [3] + "children": [ + 3 + ] } ], "sources": [ @@ -5136,7 +5343,9 @@ { "title": "Properties", "kind": 1024, - "children": [207] + "children": [ + 207 + ] } ] } @@ -5165,7 +5374,10 @@ { "title": "Properties", "kind": 1024, - "children": [205, 208] + "children": [ + 205, + 208 + ] } ] } @@ -5221,7 +5433,10 @@ { "title": "Properties", "kind": 1024, - "children": [210, 211] + "children": [ + 210, + 211 + ] } ] } @@ -5371,7 +5586,11 @@ { "title": "Properties", "kind": 1024, - "children": [170, 168, 169] + "children": [ + 170, + 168, + 169 + ] } ] } @@ -5400,7 +5619,10 @@ { "title": "Properties", "kind": 1024, - "children": [166, 171] + "children": [ + 166, + 171 + ] } ] } @@ -5456,7 +5678,10 @@ { "title": "Properties", "kind": 1024, - "children": [173, 174] + "children": [ + 173, + 174 + ] } ] } @@ -5735,7 +5960,13 @@ { "title": "Properties", "kind": 1024, - "children": [433, 430, 432, 431, 429] + "children": [ + 433, + 430, + 432, + 431, + 429 + ] } ], "sources": [ @@ -5753,7 +5984,10 @@ { "title": "Properties", "kind": 1024, - "children": [218, 219] + "children": [ + 218, + 219 + ] } ] } @@ -5820,7 +6054,9 @@ { "title": "Properties", "kind": 1024, - "children": [223] + "children": [ + 223 + ] } ] } @@ -5849,7 +6085,10 @@ { "title": "Properties", "kind": 1024, - "children": [221, 224] + "children": [ + 221, + 224 + ] } ] } @@ -5905,7 +6144,10 @@ { "title": "Properties", "kind": 1024, - "children": [226, 227] + "children": [ + 226, + 227 + ] } ] } @@ -6027,7 +6269,9 @@ { "title": "Properties", "kind": 1024, - "children": [234] + "children": [ + 234 + ] } ] } @@ -6150,7 +6394,11 @@ { "title": "Properties", "kind": 1024, - "children": [238, 239, 240] + "children": [ + 238, + 239, + 240 + ] } ] } @@ -6180,7 +6428,10 @@ { "title": "Properties", "kind": 1024, - "children": [236, 241] + "children": [ + 236, + 241 + ] } ] } @@ -6236,7 +6487,10 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244] + "children": [ + 243, + 244 + ] } ] } @@ -6469,7 +6723,13 @@ { "title": "Properties", "kind": 1024, - "children": [433, 430, 432, 431, 429] + "children": [ + 433, + 430, + 432, + 431, + 429 + ] } ], "sources": [ @@ -6487,7 +6747,9 @@ { "title": "Properties", "kind": 1024, - "children": [250] + "children": [ + 250 + ] } ] } @@ -6552,7 +6814,10 @@ { "title": "Properties", "kind": 1024, - "children": [252, 253] + "children": [ + 252, + 253 + ] } ] } @@ -6608,7 +6873,10 @@ { "title": "Properties", "kind": 1024, - "children": [255, 256] + "children": [ + 255, + 256 + ] } ] } @@ -6873,7 +7141,13 @@ { "title": "Properties", "kind": 1024, - "children": [433, 430, 432, 431, 429] + "children": [ + 433, + 430, + 432, + 431, + 429 + ] } ], "sources": [ @@ -6891,7 +7165,10 @@ { "title": "Properties", "kind": 1024, - "children": [262, 263] + "children": [ + 262, + 263 + ] } ] } @@ -6952,7 +7229,9 @@ { "title": "Properties", "kind": 1024, - "children": [267] + "children": [ + 267 + ] } ] } @@ -6963,7 +7242,9 @@ { "title": "Properties", "kind": 1024, - "children": [265] + "children": [ + 265 + ] } ] } @@ -7173,7 +7454,10 @@ { "title": "Properties", "kind": 1024, - "children": [412, 413] + "children": [ + 412, + 413 + ] } ], "sources": [ @@ -7191,7 +7475,12 @@ { "title": "Properties", "kind": 1024, - "children": [420, 421, 423, 422] + "children": [ + 420, + 421, + 423, + 422 + ] } ], "sources": [ @@ -7253,7 +7542,9 @@ { "title": "Properties", "kind": 1024, - "children": [425] + "children": [ + 425 + ] } ], "sources": [ @@ -7327,7 +7618,10 @@ { "title": "Properties", "kind": 1024, - "children": [283, 284] + "children": [ + 283, + 284 + ] } ] } @@ -7383,7 +7677,10 @@ { "title": "Properties", "kind": 1024, - "children": [286, 287] + "children": [ + 286, + 287 + ] } ] } @@ -7511,7 +7808,9 @@ { "title": "Properties", "kind": 1024, - "children": [195] + "children": [ + 195 + ] } ] } @@ -7540,7 +7839,10 @@ { "title": "Properties", "kind": 1024, - "children": [193, 196] + "children": [ + 193, + 196 + ] } ] } @@ -7596,7 +7898,10 @@ { "title": "Properties", "kind": 1024, - "children": [198, 199] + "children": [ + 198, + 199 + ] } ] } @@ -7713,7 +8018,10 @@ { "title": "Properties", "kind": 1024, - "children": [272, 273] + "children": [ + 272, + 273 + ] } ] } @@ -7769,7 +8077,10 @@ { "title": "Properties", "kind": 1024, - "children": [275, 276] + "children": [ + 275, + 276 + ] } ] } @@ -8019,7 +8330,12 @@ { "title": "Properties", "kind": 1024, - "children": [415, 416, 418, 417] + "children": [ + 415, + 416, + 418, + 417 + ] } ], "sources": [ @@ -8093,7 +8409,9 @@ { "title": "Properties", "kind": 1024, - "children": [183] + "children": [ + 183 + ] } ] } @@ -8122,7 +8440,10 @@ { "title": "Properties", "kind": 1024, - "children": [181, 184] + "children": [ + 181, + 184 + ] } ] } @@ -8178,7 +8499,10 @@ { "title": "Properties", "kind": 1024, - "children": [186, 187] + "children": [ + 186, + 187 + ] } ] } @@ -8361,7 +8685,12 @@ { "title": "Properties", "kind": 1024, - "children": [415, 416, 418, 417] + "children": [ + 415, + 416, + 418, + 417 + ] } ], "sources": [ @@ -8435,7 +8764,9 @@ { "title": "Properties", "kind": 1024, - "children": [143] + "children": [ + 143 + ] } ] } @@ -8464,7 +8795,10 @@ { "title": "Properties", "kind": 1024, - "children": [141, 144] + "children": [ + 141, + 144 + ] } ] } @@ -8520,7 +8854,10 @@ { "title": "Properties", "kind": 1024, - "children": [146, 147] + "children": [ + 146, + 147 + ] } ] } @@ -8717,7 +9054,12 @@ { "title": "Properties", "kind": 1024, - "children": [415, 416, 418, 417] + "children": [ + 415, + 416, + 418, + 417 + ] } ], "sources": [ @@ -8792,7 +9134,9 @@ { "title": "Properties", "kind": 1024, - "children": [157] + "children": [ + 157 + ] } ] } @@ -8823,7 +9167,10 @@ { "title": "Properties", "kind": 1024, - "children": [155, 158] + "children": [ + 155, + 158 + ] } ] } @@ -8872,7 +9219,10 @@ { "title": "Properties", "kind": 1024, - "children": [160, 161] + "children": [ + 160, + 161 + ] } ] } @@ -8892,12 +9242,27 @@ { "title": "Constructors", "kind": 512, - "children": [97] + "children": [ + 97 + ] }, { "title": "Methods", "kind": 2048, - "children": [200, 162, 212, 228, 245, 257, 277, 188, 268, 175, 135, 148] + "children": [ + 200, + 162, + 212, + 228, + 245, + 257, + 277, + 188, + 268, + 175, + 135, + 148 + ] } ], "sources": [ @@ -8913,7 +9278,9 @@ { "title": "Classes", "kind": 128, - "children": [96] + "children": [ + 96 + ] } ], "sources": [ @@ -8929,7 +9296,11 @@ { "title": "Modules", "kind": 2, - "children": [1, 2, 95] + "children": [ + 1, + 2, + 95 + ] } ] -} +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/supabase.json b/spec/enrichments/tsdoc_v2/supabase.json index a4d002a1dcf..eba29df7edc 100644 --- a/spec/enrichments/tsdoc_v2/supabase.json +++ b/spec/enrichments/tsdoc_v2/supabase.json @@ -1,4107 +1,4214 @@ { - "id": 0, - "name": "@supabase/supabase-js", - "kind": 1, - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1, - "name": "index", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 195, - "name": "SupabaseClientOptions", - "kind": 16777216, - "kindString": "Reference", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 20, - "character": 14 - } - ], - "target": 61 - }, - { - "id": 105, - "name": "SupabaseClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "Supabase Client.", - "text": "An isomorphic Javascript client for interacting with Postgres.\n" - }, - "children": [ - { - "id": 106, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 83, - "character": 2 - } - ], - "signatures": [ - { - "id": 107, - "name": "new SupabaseClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Create a new client for use in the browser." - }, - "typeParameter": [ - { - "id": 108, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 109, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 108, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 108, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 110, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 98, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 109, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 108, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 98, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 111, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 112, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 113, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 105, - "typeArguments": [ - { - "type": "reference", - "id": 108, - "name": "Database" - }, - { - "type": "reference", - "id": 109, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 110, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 114, - "name": "auth", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 55, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "SupabaseAuthClient" - } - }, - { - "id": 117, - "name": "authUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 59, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 127, - "name": "changedAccessToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 65, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 122, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 64, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 124, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "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": 126, - "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": 119, - "name": "functionsUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 61, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 128, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 67, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 129, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 130, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 131, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 115, - "name": "realtime", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" - } - }, - { - "id": 116, - "name": "realtimeUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 58, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 120, - "name": "rest", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 62, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 108, - "name": "Database" - }, - { - "type": "reference", - "id": 109, - "name": "SchemaName" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 109, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 108, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "qualifiedName": "GenericSchema", - "package": "@supabase/postgrest-js", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 121, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 63, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 118, - "name": "storageUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 60, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 133, - "name": "supabaseKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 132, - "name": "supabaseUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 134, - "name": "functions", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 138, - "character": 6 - } - ], - "getSignature": [ - { - "id": 135, - "name": "functions", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Functions allows you to deploy and invoke edge functions." - }, - "type": { - "type": "reference", - "qualifiedName": "FunctionsClient", - "package": "@supabase/functions-js", - "name": "FunctionsClient" - } - } - ] - }, - { - "id": 136, - "name": "storage", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 148, - "character": 6 - } - ], - "getSignature": [ - { - "id": 137, - "name": "storage", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - }, - "type": { - "type": "reference", - "qualifiedName": "StorageClient", - "package": "@supabase/storage-js", - "name": "StorageClient" - } - } - ] - }, - { - "id": 170, - "name": "_getAccessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 235, - "character": 16 - } - ], - "signatures": [ - { - "id": 171, - "name": "_getAccessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 187, - "name": "_handleTokenChanged", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 284, - "character": 10 - } - ], - "signatures": [ - { - "id": 188, - "name": "_handleTokenChanged", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 189, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "AuthChangeEvent", - "package": "@supabase/gotrue-js", - "name": "AuthChangeEvent" - } - }, - { - "id": 190, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 191, - "name": "source", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "CLIENT" - }, - { - "type": "literal", - "value": "STORAGE" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 181, - "name": "_initRealtimeClient", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 270, - "character": 10 - } - ], - "signatures": [ - { - "id": 182, - "name": "_initRealtimeClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 183, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - } - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ] - }, - { - "id": 172, - "name": "_initSupabaseAuthClient", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 241, - "character": 10 - } - ], - "signatures": [ - { - "id": 173, - "name": "_initSupabaseAuthClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 59, - "name": "SupabaseAuthClientOptions" - } - }, - { - "id": 175, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 176, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 178, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 179, - "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": 180, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "name": "SupabaseAuthClient" - } - } - ] - }, - { - "id": 184, - "name": "_listenForAuthEvents", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 277, - "character": 10 - } - ], - "signatures": [ - { - "id": 185, - "name": "_listenForAuthEvents", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - }, - { - "id": 159, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 207, - "character": 2 - } - ], - "signatures": [ - { - "id": 160, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." - }, - "parameters": [ - { - "id": 161, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The name of the Realtime channel." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 162, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The options to pass to the Realtime channel.\n\n" - }, - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannelOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ] - }, - { - "id": 138, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 157, - "character": 2 - } - ], - "signatures": [ - { - "id": 139, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a table operation." - }, - "typeParameter": [ - { - "id": 140, - "name": "TableName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 141, - "name": "Table", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 80, - "name": "GenericTable" - } - } - ], - "parameters": [ - { - "id": 142, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 140, - "name": "TableName" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 110, - "name": "Schema" - }, - { - "type": "reference", - "id": 141, - "name": "Table" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 143, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 144, - "name": "ViewName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 145, - "name": "View", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 93, - "name": "GenericView" - } - } - ], - "parameters": [ - { - "id": 146, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 144, - "name": "ViewName" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 110, - "name": "Schema" - }, - { - "type": "reference", - "id": 145, - "name": "View" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 147, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 148, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 110, - "name": "Schema" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - } - ] - }, - { - "id": 163, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 214, - "character": 2 - } - ], - "signatures": [ - { - "id": 164, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all Realtime channels." - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - } - ] - }, - { - "id": 168, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 231, - "character": 2 - } - ], - "signatures": [ - { - "id": 169, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 165, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 224, - "character": 2 - } - ], - "signatures": [ - { - "id": 166, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes Realtime channel from Realtime client." - }, - "parameters": [ - { - "id": 167, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The name of the Realtime channel.\n\n" - }, - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 149, - "name": "rpc", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 178, - "character": 2 - } - ], - "signatures": [ - { - "id": 150, - "name": "rpc", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a function call." - }, - "typeParameter": [ - { - "id": 151, - "name": "FunctionName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 152, - "name": "Function_", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 94, - "name": "GenericFunction" - } - } - ], - "parameters": [ - { - "id": 153, - "name": "fn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The function name to call." - }, - "type": { - "type": "reference", - "id": 151, - "name": "FunctionName" - } - }, - { - "id": 154, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The parameters to pass to the function call." - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Args" - }, - "objectType": { - "type": "reference", - "id": 152, - "name": "Function_" - } - }, - "defaultValue": "{}" - }, - { - "id": 155, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 156, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 158, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count rows in a table.\n\n" - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 186, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 157, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When set to true, no data will be returned." - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 185, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [158, 157] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 110, - "name": "Schema" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 152, - "name": "Function_" - } - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - } - }, - "extendsType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 152, - "name": "Function_" - } - } - ], - "qualifiedName": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [106] - }, - { - "title": "Properties", - "kind": 1024, - "children": [114, 117, 127, 122, 119, 128, 115, 116, 120, 121, 118, 133, 132] - }, - { - "title": "Accessors", - "kind": 262144, - "children": [134, 136] - }, - { - "title": "Methods", - "kind": 2048, - "children": [170, 187, 181, 172, 184, 159, 138, 163, 168, 165, 149] - } - ], - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 43, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 192, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 193, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 108, - "name": "Database" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 108, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 108, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 194, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 98, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 109, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 108, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 98, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 109, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 108, - "name": "Database" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 2, - "name": "createClient", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 25, - "character": 13 - } - ], - "signatures": [ - { - "id": 3, - "name": "createClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Supabase Client." - }, - "typeParameter": [ - { - "id": 4, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 6, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 98, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 98, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 7, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 8, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 9, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 105, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 6, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "References", - "kind": 16777216, - "children": [195] - }, - { - "title": "Classes", - "kind": 128, - "children": [105] - }, - { - "title": "Functions", - "kind": 64, - "children": [2] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 10, - "name": "lib/constants", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 11, - "name": "DEFAULT_HEADERS", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 3, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 13, - "name": "X-Client-Info", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 3, - "character": 33 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [13] - } - ] - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [11] - } - ], - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 14, - "name": "lib/fetch", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 29, - "name": "fetchWithAuth", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 25, - "character": 13 - } - ], - "signatures": [ - { - "id": 30, - "name": "fetchWithAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 31, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "getAccessToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 33, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 34, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 35, - "name": "customFetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 36, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 37, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 38, - "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": 39, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 40, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 41, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 42, - "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": 43, - "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": 15, - "name": "resolveFetch", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 5, - "character": 13 - } - ], - "signatures": [ - { - "id": 16, - "name": "resolveFetch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 17, - "name": "customFetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 19, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 20, - "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": 21, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 22, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 23, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 24, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 25, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - } - ] - }, - { - "id": 26, - "name": "resolveHeadersConstructor", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 17, - "character": 13 - } - ], - "signatures": [ - { - "id": 27, - "name": "resolveHeadersConstructor", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 28, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "kind": 64, - "children": [29, 15, 26] - } - ], - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 44, - "name": "lib/helpers", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 50, - "name": "applySettingDefaults", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 18, - "character": 16 - } - ], - "signatures": [ - { - "id": 51, - "name": "applySettingDefaults", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 52, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 53, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 52, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 52, - "name": "Database" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 54, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 53, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - }, - { - "id": 55, - "name": "defaults", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 53, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ] - }, - { - "id": 56, - "name": "isBrowser", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 16, - "character": 13 - } - ], - "signatures": [ - { - "id": 57, - "name": "isBrowser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 47, - "name": "stripTrailingSlash", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 12, - "character": 16 - } - ], - "signatures": [ - { - "id": 48, - "name": "stripTrailingSlash", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 49, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 45, - "name": "uuid", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 4, - "character": 16 - } - ], - "signatures": [ - { - "id": 46, - "name": "uuid", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "kind": 64, - "children": [50, 56, 47, 45] - } - ], - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 58, - "name": "lib/types", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 59, - "name": "SupabaseAuthClientOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 6, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "name": "GoTrueClientOptions" - } - ] - }, - { - "id": 60, - "name": "Fetch", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 18, - "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" - } - } - }, - { - "id": 94, - "name": "GenericFunction", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 95, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 96, - "name": "Args", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 97, - "name": "Returns", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [96, 97] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 30 - } - ] - } - } - }, - { - "id": 90, - "name": "GenericNonUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 91, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 92, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [92] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 38 - } - ] - } - } - }, - { - "id": 98, - "name": "GenericSchema", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 83, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 99, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 102, - "name": "Functions", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 94, - "name": "GenericFunction" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 100, - "name": "Tables", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 80, - "name": "GenericTable" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 101, - "name": "Views", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 93, - "name": "GenericView" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [102, 100, 101] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 83, - "character": 28 - } - ] - } - } - }, - { - "id": 80, - "name": "GenericTable", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 81, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 83, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 82, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 84, - "name": "Update", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [83, 82, 84] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 27 - } - ] - } - } - }, - { - "id": 85, - "name": "GenericUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 66, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 86, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 88, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 68, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 87, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 67, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 89, - "name": "Update", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 69, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [88, 87, 89] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 66, - "character": 35 - } - ] - } - } - }, - { - "id": 93, - "name": "GenericView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 76, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 85, - "name": "GenericUpdatableView" - }, - { - "type": "reference", - "id": 90, - "name": "GenericNonUpdatableView" - } - ] - } - }, - { - "id": 61, - "name": "SupabaseClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 10, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 79, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 62, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 66, - "name": "auth", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 68, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 71, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 73, - "name": "flowType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 42, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "flowType" - }, - "objectType": { - "type": "reference", - "id": 59, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 70, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 72, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A storage provider. Used to store the logged-in session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 38, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "id": 59, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 69, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 9 - } - ] - } - } - }, - { - "id": 63, - "name": "db", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 65, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 79, - "name": "SchemaName" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [65] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 7 - } - ] - } - } - }, - { - "id": 75, - "name": "global", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 77, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom `fetch` implementation." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 60, - "name": "Fetch" - } - }, - { - "id": 78, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional headers for initializing the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [77, 78] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 11 - } - ] - } - } - }, - { - "id": 74, - "name": "realtime", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Options passed to the realtime-js instance" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [66, 63, 75, 74] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 10, - "character": 48 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Interfaces", - "kind": 256, - "children": [59] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [60, 94, 90, 98, 80, 85, 93, 61] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 103, - "name": "lib/version", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 104, - "name": "version", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/version.ts", - "line": 1, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "0.0.0-automated" - }, - "defaultValue": "'0.0.0-automated'" - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [104] - } - ], - "sources": [ - { - "fileName": "src/lib/version.ts", - "line": 1, - "character": 0 - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "kind": 2, - "children": [1, 10, 14, 44, 58, 103] - } - ] -} + "id": 0, + "name": "@supabase/supabase-js", + "kind": 1, + "flags": {}, + "originalName": "", + "children": [ + { + "id": 1, + "name": "index", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 195, + "name": "SupabaseClientOptions", + "kind": 16777216, + "kindString": "Reference", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 20, + "character": 14 + } + ], + "target": 61 + }, + { + "id": 105, + "name": "SupabaseClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Supabase Client.", + "text": "An isomorphic Javascript client for interacting with Postgres.\n" + }, + "children": [ + { + "id": 106, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 83, + "character": 2 + } + ], + "signatures": [ + { + "id": 107, + "name": "new SupabaseClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Create a new client for use in the browser." + }, + "typeParameter": [ + { + "id": 108, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 109, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 108, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 108, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 110, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 98, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 109, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 108, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 98, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "parameters": [ + { + "id": 111, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 112, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 113, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "reference", + "id": 109, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 105, + "typeArguments": [ + { + "type": "reference", + "id": 108, + "name": "Database" + }, + { + "type": "reference", + "id": 109, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 110, + "name": "Schema" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 114, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 55, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "SupabaseAuthClient" + } + }, + { + "id": 117, + "name": "authUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 127, + "name": "changedAccessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 65, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 122, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 64, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 123, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 124, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 125, + "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": 126, + "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": 119, + "name": "functionsUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 61, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 128, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 67, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 129, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 130, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 131, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 115, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + }, + { + "id": 116, + "name": "realtimeUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 58, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 120, + "name": "rest", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 62, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 108, + "name": "Database" + }, + { + "type": "reference", + "id": 109, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 109, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 108, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "qualifiedName": "GenericSchema", + "package": "@supabase/postgrest-js", + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + ], + "qualifiedName": "PostgrestClient", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 121, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 63, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 118, + "name": "storageUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 133, + "name": "supabaseKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 132, + "name": "supabaseUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 134, + "name": "functions", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 138, + "character": 6 + } + ], + "getSignature": [ + { + "id": 135, + "name": "functions", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "shortText": "Supabase Functions allows you to deploy and invoke edge functions." + }, + "type": { + "type": "reference", + "qualifiedName": "FunctionsClient", + "package": "@supabase/functions-js", + "name": "FunctionsClient" + } + } + ] + }, + { + "id": 136, + "name": "storage", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 148, + "character": 6 + } + ], + "getSignature": [ + { + "id": 137, + "name": "storage", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." + }, + "type": { + "type": "reference", + "qualifiedName": "StorageClient", + "package": "@supabase/storage-js", + "name": "StorageClient" + } + } + ] + }, + { + "id": 170, + "name": "_getAccessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 235, + "character": 16 + } + ], + "signatures": [ + { + "id": 171, + "name": "_getAccessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 187, + "name": "_handleTokenChanged", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 284, + "character": 10 + } + ], + "signatures": [ + { + "id": 188, + "name": "_handleTokenChanged", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 189, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "AuthChangeEvent", + "package": "@supabase/gotrue-js", + "name": "AuthChangeEvent" + } + }, + { + "id": 190, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 191, + "name": "source", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "CLIENT" + }, + { + "type": "literal", + "value": "STORAGE" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 181, + "name": "_initRealtimeClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 270, + "character": 10 + } + ], + "signatures": [ + { + "id": 182, + "name": "_initRealtimeClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 183, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeClientOptions" + } + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ] + }, + { + "id": 172, + "name": "_initSupabaseAuthClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 241, + "character": 10 + } + ], + "signatures": [ + { + "id": 173, + "name": "_initSupabaseAuthClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 174, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 59, + "name": "SupabaseAuthClientOptions" + } + }, + { + "id": 175, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 176, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 177, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 178, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 179, + "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": 180, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "name": "SupabaseAuthClient" + } + } + ] + }, + { + "id": 184, + "name": "_listenForAuthEvents", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 277, + "character": 10 + } + ], + "signatures": [ + { + "id": 185, + "name": "_listenForAuthEvents", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 186, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + } + ] + }, + { + "id": 159, + "name": "channel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 207, + "character": 2 + } + ], + "signatures": [ + { + "id": 160, + "name": "channel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + }, + "parameters": [ + { + "id": 161, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The name of the Realtime channel." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 162, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The options to pass to the Realtime channel.\n\n" + }, + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannelOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ] + }, + { + "id": 138, + "name": "from", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 157, + "character": 2 + } + ], + "signatures": [ + { + "id": 139, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a table operation." + }, + "typeParameter": [ + { + "id": 140, + "name": "TableName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 141, + "name": "Table", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 80, + "name": "GenericTable" + } + } + ], + "parameters": [ + { + "id": 142, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 140, + "name": "TableName" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 110, + "name": "Schema" + }, + { + "type": "reference", + "id": 141, + "name": "Table" + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 143, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 144, + "name": "ViewName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 145, + "name": "View", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 93, + "name": "GenericView" + } + } + ], + "parameters": [ + { + "id": 146, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 144, + "name": "ViewName" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 110, + "name": "Schema" + }, + { + "type": "reference", + "id": 145, + "name": "View" + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 147, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 148, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 110, + "name": "Schema" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + }, + { + "id": 163, + "name": "getChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 214, + "character": 2 + } + ], + "signatures": [ + { + "id": 164, + "name": "getChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns all Realtime channels." + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + } + ] + }, + { + "id": 168, + "name": "removeAllChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 231, + "character": 2 + } + ], + "signatures": [ + { + "id": 169, + "name": "removeAllChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "error" + }, + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 165, + "name": "removeChannel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 224, + "character": 2 + } + ], + "signatures": [ + { + "id": 166, + "name": "removeChannel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unsubscribes and removes Realtime channel from Realtime client." + }, + "parameters": [ + { + "id": 167, + "name": "channel", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The name of the Realtime channel.\n\n" + }, + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "error" + }, + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 149, + "name": "rpc", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 178, + "character": 2 + } + ], + "signatures": [ + { + "id": 150, + "name": "rpc", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a function call." + }, + "typeParameter": [ + { + "id": 151, + "name": "FunctionName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 152, + "name": "Function_", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 94, + "name": "GenericFunction" + } + } + ], + "parameters": [ + { + "id": 153, + "name": "fn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The function name to call." + }, + "type": { + "type": "reference", + "id": 151, + "name": "FunctionName" + } + }, + { + "id": 154, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The parameters to pass to the function call." + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Args" + }, + "objectType": { + "type": "reference", + "id": 152, + "name": "Function_" + } + }, + "defaultValue": "{}" + }, + { + "id": 155, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 156, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 158, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count rows in a table.\n\n" + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 186, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 157, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When set to true, no data will be returned." + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 185, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 158, + 157 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 110, + "name": "Schema" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 152, + "name": "Function_" + } + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "number" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + } + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 152, + "name": "Function_" + } + } + ], + "qualifiedName": "PostgrestFilterBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 106 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 114, + 117, + 127, + 122, + 119, + 128, + 115, + 116, + 120, + 121, + 118, + 133, + 132 + ] + }, + { + "title": "Accessors", + "kind": 262144, + "children": [ + 134, + 136 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 170, + 187, + 181, + 172, + 184, + 159, + 138, + 163, + 168, + 165, + 149 + ] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 43, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 192, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 193, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 108, + "name": "Database" + } + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 108, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 108, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 194, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 98, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 109, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 108, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 98, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 109, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 108, + "name": "Database" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ] + }, + { + "id": 2, + "name": "createClient", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 25, + "character": 13 + } + ], + "signatures": [ + { + "id": 3, + "name": "createClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new Supabase Client." + }, + "typeParameter": [ + { + "id": 4, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 6, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 98, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 98, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "parameters": [ + { + "id": 7, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 8, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 9, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "reference", + "id": 5, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 105, + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 6, + "name": "Schema" + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "References", + "kind": 16777216, + "children": [ + 195 + ] + }, + { + "title": "Classes", + "kind": 128, + "children": [ + 105 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [ + 2 + ] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 10, + "name": "lib/constants", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 11, + "name": "DEFAULT_HEADERS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 3, + "character": 13 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 13, + "name": "X-Client-Info", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 3, + "character": 33 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 13 + ] + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 11 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 2, + "character": 0 + } + ] + }, + { + "id": 14, + "name": "lib/fetch", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 29, + "name": "fetchWithAuth", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 25, + "character": 13 + } + ], + "signatures": [ + { + "id": 30, + "name": "fetchWithAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 31, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 32, + "name": "getAccessToken", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 33, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 34, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 35, + "name": "customFetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 36, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 37, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 38, + "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": 39, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 40, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 41, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 42, + "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": 43, + "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": 15, + "name": "resolveFetch", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 5, + "character": 13 + } + ], + "signatures": [ + { + "id": 16, + "name": "resolveFetch", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 17, + "name": "customFetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 18, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 19, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 20, + "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": 21, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 22, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 23, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 24, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 25, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + } + ] + }, + { + "id": 26, + "name": "resolveHeadersConstructor", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 17, + "character": 13 + } + ], + "signatures": [ + { + "id": 27, + "name": "resolveHeadersConstructor", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 28, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [ + 29, + 15, + 26 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 44, + "name": "lib/helpers", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 50, + "name": "applySettingDefaults", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 18, + "character": 16 + } + ], + "signatures": [ + { + "id": 51, + "name": "applySettingDefaults", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 52, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 53, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 52, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 52, + "name": "Database" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 54, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "reference", + "id": 53, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + }, + { + "id": 55, + "name": "defaults", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "reference", + "id": 53, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ] + }, + { + "id": 56, + "name": "isBrowser", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 16, + "character": 13 + } + ], + "signatures": [ + { + "id": 57, + "name": "isBrowser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 47, + "name": "stripTrailingSlash", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 12, + "character": 16 + } + ], + "signatures": [ + { + "id": 48, + "name": "stripTrailingSlash", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 49, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 45, + "name": "uuid", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 4, + "character": 16 + } + ], + "signatures": [ + { + "id": 46, + "name": "uuid", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [ + 50, + 56, + 47, + 45 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 2, + "character": 0 + } + ] + }, + { + "id": 58, + "name": "lib/types", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 59, + "name": "SupabaseAuthClientOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 6, + "character": 17 + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "GoTrueClientOptions" + } + ] + }, + { + "id": 60, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 18, + "qualifiedName": "fetch", + "package": "typescript", + "name": "fetch" + } + } + }, + { + "id": 94, + "name": "GenericFunction", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 95, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 96, + "name": "Args", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 79, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 97, + "name": "Returns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 96, + 97 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 30 + } + ] + } + } + }, + { + "id": 90, + "name": "GenericNonUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 91, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 92, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 92 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 38 + } + ] + } + } + }, + { + "id": 98, + "name": "GenericSchema", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 99, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 102, + "name": "Functions", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 94, + "name": "GenericFunction" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 100, + "name": "Tables", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 80, + "name": "GenericTable" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 101, + "name": "Views", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 85, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 93, + "name": "GenericView" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 102, + 100, + 101 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 28 + } + ] + } + } + }, + { + "id": 80, + "name": "GenericTable", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 60, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 81, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 83, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 82, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 61, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 84, + "name": "Update", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 83, + 82, + 84 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 60, + "character": 27 + } + ] + } + } + }, + { + "id": 85, + "name": "GenericUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 86, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 88, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 87, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 89, + "name": "Update", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 88, + 87, + 89 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 35 + } + ] + } + } + }, + { + "id": 93, + "name": "GenericView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 85, + "name": "GenericUpdatableView" + }, + { + "type": "reference", + "id": 90, + "name": "GenericNonUpdatableView" + } + ] + } + }, + { + "id": 61, + "name": "SupabaseClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 79, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 62, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 66, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 67, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 68, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 22, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 71, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 34, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 73, + "name": "flowType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 4 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "flowType" + }, + "objectType": { + "type": "reference", + "id": 59, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 70, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 72, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A storage provider. Used to store the logged-in session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 38, + "character": 4 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "storage" + }, + "objectType": { + "type": "reference", + "id": 59, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 69, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional key name used for storing tokens in local storage." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 26, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 18, + "character": 9 + } + ] + } + } + }, + { + "id": 63, + "name": "db", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 64, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 65, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 15, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 79, + "name": "SchemaName" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 65 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 14, + "character": 7 + } + ] + } + } + }, + { + "id": 75, + "name": "global", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 76, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 77, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom `fetch` implementation." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 60, + "name": "Fetch" + } + }, + { + "id": 78, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional headers for initializing the client." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 77, + 78 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 11 + } + ] + } + } + }, + { + "id": 74, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Options passed to the realtime-js instance" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeClientOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 66, + 63, + 75, + 74 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 48 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Interfaces", + "kind": 256, + "children": [ + 59 + ] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [ + 60, + 94, + 90, + 98, + 80, + 85, + 93, + 61 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 103, + "name": "lib/version", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 104, + "name": "version", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 13 + } + ], + "type": { + "type": "literal", + "value": "0.0.0-automated" + }, + "defaultValue": "'0.0.0-automated'" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 104 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "kind": 2, + "children": [ + 1, + 10, + 14, + 44, + 58, + 103 + ] + } + ] +} \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/supabase_dereferenced.json b/spec/enrichments/tsdoc_v2/supabase_dereferenced.json index e77794b6363..51e4395c221 100644 --- a/spec/enrichments/tsdoc_v2/supabase_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/supabase_dereferenced.json @@ -433,7 +433,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -500,7 +507,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -625,7 +634,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -668,7 +680,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -2140,7 +2157,10 @@ { "title": "Properties", "kind": 1024, - "children": [158, 157] + "children": [ + 158, + 157 + ] } ] } @@ -2258,22 +2278,53 @@ { "title": "Constructors", "kind": 512, - "children": [106] + "children": [ + 106 + ] }, { "title": "Properties", "kind": 1024, - "children": [114, 117, 127, 122, 119, 128, 115, 116, 120, 121, 118, 133, 132] + "children": [ + 114, + 117, + 127, + 122, + 119, + 128, + 115, + 116, + 120, + 121, + 118, + 133, + 132 + ] }, { "title": "Accessors", "kind": 262144, - "children": [134, 136] + "children": [ + 134, + 136 + ] }, { "title": "Methods", "kind": 2048, - "children": [170, 187, 181, 172, 184, 159, 138, 163, 168, 165, 149] + "children": [ + 170, + 187, + 181, + 172, + 184, + 159, + 138, + 163, + 168, + 165, + 149 + ] } ], "sources": [ @@ -2799,7 +2850,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -2866,7 +2924,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -2991,7 +3051,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -3034,7 +3097,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -3080,17 +3148,23 @@ { "title": "References", "kind": 16777216, - "children": [195] + "children": [ + 195 + ] }, { "title": "Classes", "kind": 128, - "children": [105] + "children": [ + 105 + ] }, { "title": "Functions", "kind": 64, - "children": [2] + "children": [ + 2 + ] } ], "sources": [ @@ -3156,7 +3230,9 @@ { "title": "Properties", "kind": 1024, - "children": [13] + "children": [ + 13 + ] } ] } @@ -3168,7 +3244,9 @@ { "title": "Variables", "kind": 32, - "children": [11] + "children": [ + 11 + ] } ], "sources": [ @@ -3646,7 +3724,11 @@ { "title": "Functions", "kind": 64, - "children": [29, 15, 26] + "children": [ + 29, + 15, + 26 + ] } ], "sources": [ @@ -3978,7 +4060,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -4045,7 +4134,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -4170,7 +4261,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -4213,7 +4307,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -4458,7 +4557,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -4525,7 +4631,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -4650,7 +4758,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -4693,7 +4804,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -4823,7 +4939,12 @@ { "title": "Functions", "kind": 64, - "children": [50, 56, 47, 45] + "children": [ + 50, + 56, + 47, + 45 + ] } ], "sources": [ @@ -4960,7 +5081,10 @@ { "title": "Properties", "kind": 1024, - "children": [96, 97] + "children": [ + 96, + 97 + ] } ], "sources": [ @@ -5030,7 +5154,9 @@ { "title": "Properties", "kind": 1024, - "children": [92] + "children": [ + 92 + ] } ], "sources": [ @@ -5163,7 +5289,11 @@ { "title": "Properties", "kind": 1024, - "children": [102, 100, 101] + "children": [ + 102, + 100, + 101 + ] } ], "sources": [ @@ -5293,7 +5423,11 @@ { "title": "Properties", "kind": 1024, - "children": [83, 82, 84] + "children": [ + 83, + 82, + 84 + ] } ], "sources": [ @@ -5423,7 +5557,11 @@ { "title": "Properties", "kind": 1024, - "children": [88, 87, 89] + "children": [ + 88, + 87, + 89 + ] } ], "sources": [ @@ -5569,7 +5707,11 @@ { "title": "Properties", "kind": 1024, - "children": [88, 87, 89] + "children": [ + 88, + 87, + 89 + ] } ], "sources": [ @@ -5639,7 +5781,9 @@ { "title": "Properties", "kind": 1024, - "children": [92] + "children": [ + 92 + ] } ], "sources": [ @@ -5869,7 +6013,14 @@ { "title": "Properties", "kind": 1024, - "children": [68, 71, 73, 70, 72, 69] + "children": [ + 68, + 71, + 73, + 70, + 72, + 69 + ] } ], "sources": [ @@ -5936,7 +6087,9 @@ { "title": "Properties", "kind": 1024, - "children": [65] + "children": [ + 65 + ] } ], "sources": [ @@ -6061,7 +6214,10 @@ { "title": "Properties", "kind": 1024, - "children": [77, 78] + "children": [ + 77, + 78 + ] } ], "sources": [ @@ -6104,7 +6260,12 @@ { "title": "Properties", "kind": 1024, - "children": [66, 63, 75, 74] + "children": [ + 66, + 63, + 75, + 74 + ] } ], "sources": [ @@ -6122,12 +6283,23 @@ { "title": "Interfaces", "kind": 256, - "children": [59] + "children": [ + 59 + ] }, { "title": "Type Aliases", "kind": 4194304, - "children": [60, 94, 90, 98, 80, 85, 93, 61] + "children": [ + 60, + 94, + 90, + 98, + 80, + 85, + 93, + 61 + ] } ], "sources": [ @@ -6171,7 +6343,9 @@ { "title": "Variables", "kind": 32, - "children": [104] + "children": [ + 104 + ] } ], "sources": [ @@ -6187,7 +6361,14 @@ { "title": "Modules", "kind": 2, - "children": [1, 10, 14, 44, 58, 103] + "children": [ + 1, + 10, + 14, + 44, + 58, + 103 + ] } ] -} +} \ No newline at end of file From 09ff703a4907e327dd8177153463093ea64d6cd9 Mon Sep 17 00:00:00 2001 From: Kang Ming Date: Wed, 24 May 2023 02:07:46 +0800 Subject: [PATCH 2/4] update auth docs --- spec/common-client-libs-sections.json | 14 +++++ spec/supabase_js_v2.yml | 76 +++++++++++++++++++++++++++ 2 files changed, 90 insertions(+) diff --git a/spec/common-client-libs-sections.json b/spec/common-client-libs-sections.json index d90b37c39bf..bb798f689d6 100644 --- a/spec/common-client-libs-sections.json +++ b/spec/common-client-libs-sections.json @@ -541,6 +541,20 @@ "product": "auth", "type": "function" }, + { + "id": "send-password-reauthentication", + "title": "Send a password reauthentication nonce", + "slug": "auth-reauthentication", + "product": "auth", + "type": "function" + }, + { + "id": "resend-email-or-phone-otps", + "title": "Resend an OTP", + "slug": "auth-resend", + "product": "auth", + "type": "function" + }, { "id": "set-session", "title": "Set the session data", diff --git a/spec/supabase_js_v2.yml b/spec/supabase_js_v2.yml index 2b06ecc41f8..9a8f0d1a1b5 100644 --- a/spec/supabase_js_v2.yml +++ b/spec/supabase_js_v2.yml @@ -465,6 +465,82 @@ functions: data: { hello: 'world' } }) ``` + - id: update-password-with-reauthentication + name: Update the user's password with a nonce + description: If "Secure password change" is enabled, updating the user's password would require a nonce. The nonce is sent to the user's email or phone number. + isSpotlight: true + code: | + ```js + const { data, error } = await supabase.auth.updateUser({ + password: 'new password', + nonce: '123456' + }) + ``` + - id: send-password-reauthentication + title: 'reauthenticate()' + $ref: '@supabase/gotrue-js.GoTrueClient.reauthenticate' + notes: | + - This method is used together with `updateUser()` when a user's password needs to be updated. + - This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead. + examples: + - id: send-reauthentication-nonce + name: Send reauthentication nonce + description: Sends a reauthentication nonce to the user's email or phone number. + isSpotlight: true + code: | + ```js + const { data, error } = await supabase.auth.reauthenticate() + ``` + - id: resend-email-or-phone-otps + title: 'resend()' + $ref: '@supabase/gotrue-js.GoTrueClient.resend' + notes: | + - Resends a signup confirmation, email change or phone change email to the user. + - Passwordless sign-ins can be resent by calling the `signInWithOtp()` method again. + - Password recovery emails can be resent by calling the `resetPassswordForEmail()` method again. + - This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made. + examples: + - id: resend-email-signup-confirmation + name: Resend an email signup confirmation + description: Resends the email signup confirmation to the user + isSpotlight: true + code: | + ```js + const { data, error } = await supabase.auth.resend({ + type: 'signup', + email: 'email@example.com' + }) + ``` + - id: resend-phone-signup-confirmation + name: Resend a phone signup confirmation + description: Resends the phone signup confirmation email to the user + code: | + ```js + const { data, error } = await supabase.auth.resend({ + type: 'sms', + phone: '1234567890' + }) + ``` + - id: resend-email-change-email + name: Resend email change email + description: Resends the email change email to the user + code: | + ```js + const { data, error } = await supabase.auth.resend({ + type: 'email_change', + email: 'email@example.com' + }) + ``` + - id: resend-phone-change + name: Resend phone change OTP + description: Resends the phone change OTP to the user + code: | + ```js + const { data, error } = await supabase.auth.resend({ + type: 'phone_change', + phone: '1234567890' + }) + ``` - id: set-session title: 'setSession()' $ref: '@supabase/gotrue-js.GoTrueClient.setSession' From 2835f1769feb7797d5f0710a9d708f6415e410a1 Mon Sep 17 00:00:00 2001 From: Kang Ming Date: Fri, 26 May 2023 12:02:48 +0800 Subject: [PATCH 3/4] separate MFA methods & update method descriptions --- spec/common-client-libs-sections.json | 102 ++++++++++++++------------ spec/supabase_js_v2.yml | 13 ++++ 2 files changed, 68 insertions(+), 47 deletions(-) diff --git a/spec/common-client-libs-sections.json b/spec/common-client-libs-sections.json index bb798f689d6..d3b7525192c 100644 --- a/spec/common-client-libs-sections.json +++ b/spec/common-client-libs-sections.json @@ -457,6 +457,13 @@ "product": "auth", "type": "function" }, + { + "id": "reset-password-for-email", + "title": "Send a password reset request", + "slug": "auth-resetpasswordforemail", + "product": "auth", + "type": "function" + }, { "id": "session", "title": "Retrieve a session", @@ -577,46 +584,54 @@ "type": "function" }, { - "id": "mfa-enroll", - "title": "Enroll a factor", - "slug": "auth-mfa-enroll", - "product": "auth", - "type": "function" - }, - { - "id": "mfa-challenge", - "title": "Create a challenge", - "slug": "auth-mfa-challenge", - "product": "auth", - "type": "function" - }, - { - "id": "mfa-verify", - "title": "Verify a challenge", - "slug": "auth-mfa-verify", - "product": "auth", - "type": "function" - }, - { - "id": "mfa-challenge-and-verify", - "title": "Create and verify a challenge", - "slug": "auth-mfa-challengeandverify", - "product": "auth", - "type": "function" - }, - { - "id": "mfa-unenroll", - "title": "Unenroll a factor", - "slug": "auth-mfa-unenroll", - "product": "auth", - "type": "function" - }, - { - "id": "mfa-get-authenticator-assurance-level", - "title": "Get Authenticator Assurance Level", - "slug": "auth-mfa-getauthenticatorassurancelevel", - "product": "auth", - "type": "function" + "id": "auth-mfa-api", + "title": "Auth MFA", + "slug": "auth-mfa-api", + "type": "function", + "items": [ + { + "id": "mfa-enroll", + "title": "Enroll a factor", + "slug": "auth-mfa-enroll", + "product": "auth", + "type": "function" + }, + { + "id": "mfa-challenge", + "title": "Create a challenge", + "slug": "auth-mfa-challenge", + "product": "auth", + "type": "function" + }, + { + "id": "mfa-verify", + "title": "Verify a challenge", + "slug": "auth-mfa-verify", + "product": "auth", + "type": "function" + }, + { + "id": "mfa-challenge-and-verify", + "title": "Create and verify a challenge", + "slug": "auth-mfa-challengeandverify", + "product": "auth", + "type": "function" + }, + { + "id": "mfa-unenroll", + "title": "Unenroll a factor", + "slug": "auth-mfa-unenroll", + "product": "auth", + "type": "function" + }, + { + "id": "mfa-get-authenticator-assurance-level", + "title": "Get Authenticator Assurance Level", + "slug": "auth-mfa-getauthenticatorassurancelevel", + "product": "auth", + "type": "function" + } + ] }, { "id": "admin-api", @@ -659,13 +674,6 @@ "product": "auth-admin", "type": "function" }, - { - "id": "reset-password-for-email", - "title": "Send a password reset request", - "slug": "auth-admin-resetpasswordforemail", - "product": "auth-admin", - "type": "function" - }, { "id": "generate-link", "title": "Generate an email link", diff --git a/spec/supabase_js_v2.yml b/spec/supabase_js_v2.yml index 08aaaf6f95d..81d284826f8 100644 --- a/spec/supabase_js_v2.yml +++ b/spec/supabase_js_v2.yml @@ -659,7 +659,14 @@ functions: ```js supabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225') ``` + - id: auth-mfa-api + title: 'Overview' + notes: | + This section contains methods commonly used for Multi-Factor Authentication (MFA) and are invoked behind the `supabase.auth.mfa` namespace. + Currently, we only support time-based one-time password (TOTP) as the 2nd factor. We don't support recovery codes but we allow users to enroll more than 1 TOTP factor, with an upper limit of 10. + + Having a 2nd TOTP factor for recovery frees the user of the burden of having to store their recovery codes somewhere. It also reduces the attack surface since multiple recovery codes are usually generated compared to just having 1 backup TOTP factor. - id: mfa-enroll title: 'mfa.enroll()' $ref: '@supabase/gotrue-js.GoTrueMFAApi.enroll' @@ -833,6 +840,8 @@ functions: $ref: '@supabase/gotrue-js.GoTrueAdminApi.createUser' notes: | - To confirm the user's email address or phone number, set `email_confirm` or `phone_confirm` to true. Both arguments default to false. + - `createUser()` will not send a confirmation email to the user. You can use [`inviteUserByEmail()`](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead. + - If you are sure that the created user's email or phone number is legitimate and verified, you can set the `email_confirm` or `phone_confirm` param to `true`. examples: - id: create-a-new-user-with-custom-user-metadata name: With custom user metadata @@ -954,6 +963,10 @@ functions: - id: generate-link title: 'generateLink()' $ref: '@supabase/gotrue-js.GoTrueAdminApi.generateLink' + notes: | + - The following types can be passed into `generateLink()`: `signup`, `magiclink`, `invite`, `recovery`, `email_change_current`, `email_change_new`, `phone_change`. + - `generateLink()` only generates the email link for `email_change_email` if the "Secure email change" setting is enabled under the "Email" provider in your Supabase project. + - `generateLink()` handles the creation of the user for `signup`, `invite` and `magiclink`. examples: - id: generate-a-signup-link name: Generate a signup link From a915bf7069d9e62bd208494ad3d2c752c7f70dce Mon Sep 17 00:00:00 2001 From: Kang Ming Date: Fri, 26 May 2023 14:30:58 +0800 Subject: [PATCH 4/4] fix misspell --- spec/enrichments/tsdoc_v2/combined.json | 2 +- spec/enrichments/tsdoc_v2/gotrue.json | 2 +- spec/enrichments/tsdoc_v2/gotrue_dereferenced.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/enrichments/tsdoc_v2/combined.json b/spec/enrichments/tsdoc_v2/combined.json index 73663ae54b7..f1c8db966ee 100644 --- a/spec/enrichments/tsdoc_v2/combined.json +++ b/spec/enrichments/tsdoc_v2/combined.json @@ -19545,7 +19545,7 @@ "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 desireable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n{@see #stopAutoRefresh}\n" + "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", diff --git a/spec/enrichments/tsdoc_v2/gotrue.json b/spec/enrichments/tsdoc_v2/gotrue.json index 9c6c5bb34d2..b5b1728dc19 100644 --- a/spec/enrichments/tsdoc_v2/gotrue.json +++ b/spec/enrichments/tsdoc_v2/gotrue.json @@ -5428,7 +5428,7 @@ "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 desireable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n{@see #stopAutoRefresh}\n" + "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", diff --git a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json index 1016eccaad1..1df0bc85cf5 100644 --- a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json @@ -13168,7 +13168,7 @@ "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 desireable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n{@see #stopAutoRefresh}\n" + "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",