@supabase/auth-js 2.81.1 → 2.81.2-canary.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/dist/main/GoTrueAdminApi.d.ts +13 -0
  2. package/dist/main/GoTrueAdminApi.d.ts.map +1 -1
  3. package/dist/main/GoTrueAdminApi.js +13 -0
  4. package/dist/main/GoTrueAdminApi.js.map +1 -1
  5. package/dist/main/GoTrueClient.d.ts +11 -0
  6. package/dist/main/GoTrueClient.d.ts.map +1 -1
  7. package/dist/main/GoTrueClient.js +11 -0
  8. package/dist/main/GoTrueClient.js.map +1 -1
  9. package/dist/main/lib/errors.d.ts +127 -0
  10. package/dist/main/lib/errors.d.ts.map +1 -1
  11. package/dist/main/lib/errors.js +127 -0
  12. package/dist/main/lib/errors.js.map +1 -1
  13. package/dist/main/lib/locks.d.ts +43 -0
  14. package/dist/main/lib/locks.d.ts.map +1 -1
  15. package/dist/main/lib/locks.js +43 -0
  16. package/dist/main/lib/locks.js.map +1 -1
  17. package/dist/main/lib/version.d.ts +1 -1
  18. package/dist/main/lib/version.d.ts.map +1 -1
  19. package/dist/main/lib/version.js +1 -1
  20. package/dist/main/lib/version.js.map +1 -1
  21. package/dist/module/GoTrueAdminApi.d.ts +13 -0
  22. package/dist/module/GoTrueAdminApi.d.ts.map +1 -1
  23. package/dist/module/GoTrueAdminApi.js +13 -0
  24. package/dist/module/GoTrueAdminApi.js.map +1 -1
  25. package/dist/module/GoTrueClient.d.ts +11 -0
  26. package/dist/module/GoTrueClient.d.ts.map +1 -1
  27. package/dist/module/GoTrueClient.js +11 -0
  28. package/dist/module/GoTrueClient.js.map +1 -1
  29. package/dist/module/lib/errors.d.ts +127 -0
  30. package/dist/module/lib/errors.d.ts.map +1 -1
  31. package/dist/module/lib/errors.js +127 -0
  32. package/dist/module/lib/errors.js.map +1 -1
  33. package/dist/module/lib/locks.d.ts +43 -0
  34. package/dist/module/lib/locks.d.ts.map +1 -1
  35. package/dist/module/lib/locks.js +43 -0
  36. package/dist/module/lib/locks.js.map +1 -1
  37. package/dist/module/lib/version.d.ts +1 -1
  38. package/dist/module/lib/version.d.ts.map +1 -1
  39. package/dist/module/lib/version.js +1 -1
  40. package/dist/module/lib/version.js.map +1 -1
  41. package/dist/tsconfig.module.tsbuildinfo +1 -1
  42. package/dist/tsconfig.tsbuildinfo +1 -1
  43. package/package.json +1 -1
  44. package/src/GoTrueAdminApi.ts +13 -0
  45. package/src/GoTrueClient.ts +11 -0
  46. package/src/lib/errors.ts +127 -0
  47. package/src/lib/locks.ts +43 -0
  48. package/src/lib/version.ts +1 -1
@@ -1,5 +1,15 @@
1
1
  import { WeakPasswordReasons } from './types';
2
2
  import { ErrorCode } from './error-codes';
3
+ /**
4
+ * Base error thrown by Supabase Auth helpers.
5
+ *
6
+ * @example
7
+ * ```ts
8
+ * import { AuthError } from '@supabase/auth-js'
9
+ *
10
+ * throw new AuthError('Unexpected auth error', 500, 'unexpected')
11
+ * ```
12
+ */
3
13
  export declare class AuthError extends Error {
4
14
  /**
5
15
  * Error code associated with the error. Most errors coming from
@@ -14,30 +24,107 @@ export declare class AuthError extends Error {
14
24
  constructor(message: string, status?: number, code?: string);
15
25
  }
16
26
  export declare function isAuthError(error: unknown): error is AuthError;
27
+ /**
28
+ * Error returned directly from the GoTrue REST API.
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * import { AuthApiError } from '@supabase/auth-js'
33
+ *
34
+ * throw new AuthApiError('Invalid credentials', 400, 'invalid_credentials')
35
+ * ```
36
+ */
17
37
  export declare class AuthApiError extends AuthError {
18
38
  status: number;
19
39
  constructor(message: string, status: number, code: string | undefined);
20
40
  }
21
41
  export declare function isAuthApiError(error: unknown): error is AuthApiError;
42
+ /**
43
+ * Wraps non-standard errors so callers can inspect the root cause.
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * import { AuthUnknownError } from '@supabase/auth-js'
48
+ *
49
+ * try {
50
+ * await someAuthCall()
51
+ * } catch (err) {
52
+ * throw new AuthUnknownError('Auth failed', err)
53
+ * }
54
+ * ```
55
+ */
22
56
  export declare class AuthUnknownError extends AuthError {
23
57
  originalError: unknown;
24
58
  constructor(message: string, originalError: unknown);
25
59
  }
60
+ /**
61
+ * Flexible error class used to create named auth errors at runtime.
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * import { CustomAuthError } from '@supabase/auth-js'
66
+ *
67
+ * throw new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')
68
+ * ```
69
+ */
26
70
  export declare class CustomAuthError extends AuthError {
27
71
  name: string;
28
72
  status: number;
29
73
  constructor(message: string, name: string, status: number, code: string | undefined);
30
74
  }
75
+ /**
76
+ * Error thrown when an operation requires a session but none is present.
77
+ *
78
+ * @example
79
+ * ```ts
80
+ * import { AuthSessionMissingError } from '@supabase/auth-js'
81
+ *
82
+ * throw new AuthSessionMissingError()
83
+ * ```
84
+ */
31
85
  export declare class AuthSessionMissingError extends CustomAuthError {
32
86
  constructor();
33
87
  }
34
88
  export declare function isAuthSessionMissingError(error: any): error is AuthSessionMissingError;
89
+ /**
90
+ * Error thrown when the token response is malformed.
91
+ *
92
+ * @example
93
+ * ```ts
94
+ * import { AuthInvalidTokenResponseError } from '@supabase/auth-js'
95
+ *
96
+ * throw new AuthInvalidTokenResponseError()
97
+ * ```
98
+ */
35
99
  export declare class AuthInvalidTokenResponseError extends CustomAuthError {
36
100
  constructor();
37
101
  }
102
+ /**
103
+ * Error thrown when email/password credentials are invalid.
104
+ *
105
+ * @example
106
+ * ```ts
107
+ * import { AuthInvalidCredentialsError } from '@supabase/auth-js'
108
+ *
109
+ * throw new AuthInvalidCredentialsError('Email or password is incorrect')
110
+ * ```
111
+ */
38
112
  export declare class AuthInvalidCredentialsError extends CustomAuthError {
39
113
  constructor(message: string);
40
114
  }
115
+ /**
116
+ * Error thrown when implicit grant redirects contain an error.
117
+ *
118
+ * @example
119
+ * ```ts
120
+ * import { AuthImplicitGrantRedirectError } from '@supabase/auth-js'
121
+ *
122
+ * throw new AuthImplicitGrantRedirectError('OAuth redirect failed', {
123
+ * error: 'access_denied',
124
+ * code: 'oauth_error',
125
+ * })
126
+ * ```
127
+ */
41
128
  export declare class AuthImplicitGrantRedirectError extends CustomAuthError {
42
129
  details: {
43
130
  error: string;
@@ -58,6 +145,16 @@ export declare class AuthImplicitGrantRedirectError extends CustomAuthError {
58
145
  };
59
146
  }
60
147
  export declare function isAuthImplicitGrantRedirectError(error: any): error is AuthImplicitGrantRedirectError;
148
+ /**
149
+ * Error thrown during PKCE code exchanges.
150
+ *
151
+ * @example
152
+ * ```ts
153
+ * import { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'
154
+ *
155
+ * throw new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')
156
+ * ```
157
+ */
61
158
  export declare class AuthPKCEGrantCodeExchangeError extends CustomAuthError {
62
159
  details: {
63
160
  error: string;
@@ -77,6 +174,16 @@ export declare class AuthPKCEGrantCodeExchangeError extends CustomAuthError {
77
174
  } | null;
78
175
  };
79
176
  }
177
+ /**
178
+ * Error thrown when a transient fetch issue occurs.
179
+ *
180
+ * @example
181
+ * ```ts
182
+ * import { AuthRetryableFetchError } from '@supabase/auth-js'
183
+ *
184
+ * throw new AuthRetryableFetchError('Service temporarily unavailable', 503)
185
+ * ```
186
+ */
80
187
  export declare class AuthRetryableFetchError extends CustomAuthError {
81
188
  constructor(message: string, status: number);
82
189
  }
@@ -86,6 +193,16 @@ export declare function isAuthRetryableFetchError(error: unknown): error is Auth
86
193
  * weak. Inspect the reasons to identify what password strength rules are
87
194
  * inadequate.
88
195
  */
196
+ /**
197
+ * Error thrown when a supplied password is considered weak.
198
+ *
199
+ * @example
200
+ * ```ts
201
+ * import { AuthWeakPasswordError } from '@supabase/auth-js'
202
+ *
203
+ * throw new AuthWeakPasswordError('Password too short', 400, ['min_length'])
204
+ * ```
205
+ */
89
206
  export declare class AuthWeakPasswordError extends CustomAuthError {
90
207
  /**
91
208
  * Reasons why the password is deemed weak.
@@ -94,6 +211,16 @@ export declare class AuthWeakPasswordError extends CustomAuthError {
94
211
  constructor(message: string, status: number, reasons: WeakPasswordReasons[]);
95
212
  }
96
213
  export declare function isAuthWeakPasswordError(error: unknown): error is AuthWeakPasswordError;
214
+ /**
215
+ * Error thrown when a JWT cannot be verified or parsed.
216
+ *
217
+ * @example
218
+ * ```ts
219
+ * import { AuthInvalidJwtError } from '@supabase/auth-js'
220
+ *
221
+ * throw new AuthInvalidJwtError('Token signature is invalid')
222
+ * ```
223
+ */
97
224
  export declare class AuthInvalidJwtError extends CustomAuthError {
98
225
  constructor(message: string);
99
226
  }
@@ -1 +1 @@
1
- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/lib/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAEzC,qBAAa,SAAU,SAAQ,KAAK;IAClC;;;;;OAKG;IACH,IAAI,EAAE,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,SAAS,CAAA;IAE3C,8CAA8C;IAC9C,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1B,SAAS,CAAC,aAAa,UAAO;gBAElB,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;CAM5D;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D;AAED,qBAAa,YAAa,SAAQ,SAAS;IACzC,MAAM,EAAE,MAAM,CAAA;gBAEF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS;CAMtE;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAEpE;AAED,qBAAa,gBAAiB,SAAQ,SAAS;IAC7C,aAAa,EAAE,OAAO,CAAA;gBAEV,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO;CAKpD;AAED,qBAAa,eAAgB,SAAQ,SAAS;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;gBAEF,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS;CAKpF;AAED,qBAAa,uBAAwB,SAAQ,eAAe;;CAI3D;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,uBAAuB,CAEtF;AAED,qBAAa,6BAA8B,SAAQ,eAAe;;CAIjE;AAED,qBAAa,2BAA4B,SAAQ,eAAe;gBAClD,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,8BAA+B,SAAQ,eAAe;IACjE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAO;gBAC1C,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAW;IAKnF,MAAM;;;;;mBANY,MAAM;kBAAQ,MAAM;;;CAcvC;AAED,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,GAAG,GACT,KAAK,IAAI,8BAA8B,CAEzC;AAED,qBAAa,8BAA+B,SAAQ,eAAe;IACjE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAO;gBAE1C,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAW;IAKnF,MAAM;;;;;mBAPY,MAAM;kBAAQ,MAAM;;;CAevC;AAED,qBAAa,uBAAwB,SAAQ,eAAe;gBAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAG5C;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,uBAAuB,CAE1F;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,eAAe;IACxD;;OAEG;IACH,OAAO,EAAE,mBAAmB,EAAE,CAAA;gBAElB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE;CAK5E;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,qBAAqB,CAEtF;AAED,qBAAa,mBAAoB,SAAQ,eAAe;gBAC1C,OAAO,EAAE,MAAM;CAG5B"}
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/lib/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAEzC;;;;;;;;;GASG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC;;;;;OAKG;IACH,IAAI,EAAE,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,SAAS,CAAA;IAE3C,8CAA8C;IAC9C,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1B,SAAS,CAAC,aAAa,UAAO;gBAElB,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;CAM5D;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D;AAED;;;;;;;;;GASG;AACH,qBAAa,YAAa,SAAQ,SAAS;IACzC,MAAM,EAAE,MAAM,CAAA;gBAEF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS;CAMtE;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAEpE;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,gBAAiB,SAAQ,SAAS;IAC7C,aAAa,EAAE,OAAO,CAAA;gBAEV,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO;CAKpD;AAED;;;;;;;;;GASG;AACH,qBAAa,eAAgB,SAAQ,SAAS;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;gBAEF,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS;CAKpF;AAED;;;;;;;;;GASG;AACH,qBAAa,uBAAwB,SAAQ,eAAe;;CAI3D;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,uBAAuB,CAEtF;AAED;;;;;;;;;GASG;AACH,qBAAa,6BAA8B,SAAQ,eAAe;;CAIjE;AAED;;;;;;;;;GASG;AACH,qBAAa,2BAA4B,SAAQ,eAAe;gBAClD,OAAO,EAAE,MAAM;CAG5B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,8BAA+B,SAAQ,eAAe;IACjE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAO;gBAC1C,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAW;IAKnF,MAAM;;;;;mBANY,MAAM;kBAAQ,MAAM;;;CAcvC;AAED,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,GAAG,GACT,KAAK,IAAI,8BAA8B,CAEzC;AAED;;;;;;;;;GASG;AACH,qBAAa,8BAA+B,SAAQ,eAAe;IACjE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAO;gBAE1C,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAW;IAKnF,MAAM;;;;;mBAPY,MAAM;kBAAQ,MAAM;;;CAevC;AAED;;;;;;;;;GASG;AACH,qBAAa,uBAAwB,SAAQ,eAAe;gBAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAG5C;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,uBAAuB,CAE1F;AAED;;;;GAIG;AACH;;;;;;;;;GASG;AACH,qBAAa,qBAAsB,SAAQ,eAAe;IACxD;;OAEG;IACH,OAAO,EAAE,mBAAmB,EAAE,CAAA;gBAElB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE;CAK5E;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,qBAAqB,CAEtF;AAED;;;;;;;;;GASG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;gBAC1C,OAAO,EAAE,MAAM;CAG5B"}
@@ -1,3 +1,13 @@
1
+ /**
2
+ * Base error thrown by Supabase Auth helpers.
3
+ *
4
+ * @example
5
+ * ```ts
6
+ * import { AuthError } from '@supabase/auth-js'
7
+ *
8
+ * throw new AuthError('Unexpected auth error', 500, 'unexpected')
9
+ * ```
10
+ */
1
11
  export class AuthError extends Error {
2
12
  constructor(message, status, code) {
3
13
  super(message);
@@ -10,6 +20,16 @@ export class AuthError extends Error {
10
20
  export function isAuthError(error) {
11
21
  return typeof error === 'object' && error !== null && '__isAuthError' in error;
12
22
  }
23
+ /**
24
+ * Error returned directly from the GoTrue REST API.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * import { AuthApiError } from '@supabase/auth-js'
29
+ *
30
+ * throw new AuthApiError('Invalid credentials', 400, 'invalid_credentials')
31
+ * ```
32
+ */
13
33
  export class AuthApiError extends AuthError {
14
34
  constructor(message, status, code) {
15
35
  super(message, status, code);
@@ -21,6 +41,20 @@ export class AuthApiError extends AuthError {
21
41
  export function isAuthApiError(error) {
22
42
  return isAuthError(error) && error.name === 'AuthApiError';
23
43
  }
44
+ /**
45
+ * Wraps non-standard errors so callers can inspect the root cause.
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * import { AuthUnknownError } from '@supabase/auth-js'
50
+ *
51
+ * try {
52
+ * await someAuthCall()
53
+ * } catch (err) {
54
+ * throw new AuthUnknownError('Auth failed', err)
55
+ * }
56
+ * ```
57
+ */
24
58
  export class AuthUnknownError extends AuthError {
25
59
  constructor(message, originalError) {
26
60
  super(message);
@@ -28,6 +62,16 @@ export class AuthUnknownError extends AuthError {
28
62
  this.originalError = originalError;
29
63
  }
30
64
  }
65
+ /**
66
+ * Flexible error class used to create named auth errors at runtime.
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * import { CustomAuthError } from '@supabase/auth-js'
71
+ *
72
+ * throw new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')
73
+ * ```
74
+ */
31
75
  export class CustomAuthError extends AuthError {
32
76
  constructor(message, name, status, code) {
33
77
  super(message, status, code);
@@ -35,6 +79,16 @@ export class CustomAuthError extends AuthError {
35
79
  this.status = status;
36
80
  }
37
81
  }
82
+ /**
83
+ * Error thrown when an operation requires a session but none is present.
84
+ *
85
+ * @example
86
+ * ```ts
87
+ * import { AuthSessionMissingError } from '@supabase/auth-js'
88
+ *
89
+ * throw new AuthSessionMissingError()
90
+ * ```
91
+ */
38
92
  export class AuthSessionMissingError extends CustomAuthError {
39
93
  constructor() {
40
94
  super('Auth session missing!', 'AuthSessionMissingError', 400, undefined);
@@ -43,16 +97,49 @@ export class AuthSessionMissingError extends CustomAuthError {
43
97
  export function isAuthSessionMissingError(error) {
44
98
  return isAuthError(error) && error.name === 'AuthSessionMissingError';
45
99
  }
100
+ /**
101
+ * Error thrown when the token response is malformed.
102
+ *
103
+ * @example
104
+ * ```ts
105
+ * import { AuthInvalidTokenResponseError } from '@supabase/auth-js'
106
+ *
107
+ * throw new AuthInvalidTokenResponseError()
108
+ * ```
109
+ */
46
110
  export class AuthInvalidTokenResponseError extends CustomAuthError {
47
111
  constructor() {
48
112
  super('Auth session or user missing', 'AuthInvalidTokenResponseError', 500, undefined);
49
113
  }
50
114
  }
115
+ /**
116
+ * Error thrown when email/password credentials are invalid.
117
+ *
118
+ * @example
119
+ * ```ts
120
+ * import { AuthInvalidCredentialsError } from '@supabase/auth-js'
121
+ *
122
+ * throw new AuthInvalidCredentialsError('Email or password is incorrect')
123
+ * ```
124
+ */
51
125
  export class AuthInvalidCredentialsError extends CustomAuthError {
52
126
  constructor(message) {
53
127
  super(message, 'AuthInvalidCredentialsError', 400, undefined);
54
128
  }
55
129
  }
130
+ /**
131
+ * Error thrown when implicit grant redirects contain an error.
132
+ *
133
+ * @example
134
+ * ```ts
135
+ * import { AuthImplicitGrantRedirectError } from '@supabase/auth-js'
136
+ *
137
+ * throw new AuthImplicitGrantRedirectError('OAuth redirect failed', {
138
+ * error: 'access_denied',
139
+ * code: 'oauth_error',
140
+ * })
141
+ * ```
142
+ */
56
143
  export class AuthImplicitGrantRedirectError extends CustomAuthError {
57
144
  constructor(message, details = null) {
58
145
  super(message, 'AuthImplicitGrantRedirectError', 500, undefined);
@@ -71,6 +158,16 @@ export class AuthImplicitGrantRedirectError extends CustomAuthError {
71
158
  export function isAuthImplicitGrantRedirectError(error) {
72
159
  return isAuthError(error) && error.name === 'AuthImplicitGrantRedirectError';
73
160
  }
161
+ /**
162
+ * Error thrown during PKCE code exchanges.
163
+ *
164
+ * @example
165
+ * ```ts
166
+ * import { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'
167
+ *
168
+ * throw new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')
169
+ * ```
170
+ */
74
171
  export class AuthPKCEGrantCodeExchangeError extends CustomAuthError {
75
172
  constructor(message, details = null) {
76
173
  super(message, 'AuthPKCEGrantCodeExchangeError', 500, undefined);
@@ -86,6 +183,16 @@ export class AuthPKCEGrantCodeExchangeError extends CustomAuthError {
86
183
  };
87
184
  }
88
185
  }
186
+ /**
187
+ * Error thrown when a transient fetch issue occurs.
188
+ *
189
+ * @example
190
+ * ```ts
191
+ * import { AuthRetryableFetchError } from '@supabase/auth-js'
192
+ *
193
+ * throw new AuthRetryableFetchError('Service temporarily unavailable', 503)
194
+ * ```
195
+ */
89
196
  export class AuthRetryableFetchError extends CustomAuthError {
90
197
  constructor(message, status) {
91
198
  super(message, 'AuthRetryableFetchError', status, undefined);
@@ -99,6 +206,16 @@ export function isAuthRetryableFetchError(error) {
99
206
  * weak. Inspect the reasons to identify what password strength rules are
100
207
  * inadequate.
101
208
  */
209
+ /**
210
+ * Error thrown when a supplied password is considered weak.
211
+ *
212
+ * @example
213
+ * ```ts
214
+ * import { AuthWeakPasswordError } from '@supabase/auth-js'
215
+ *
216
+ * throw new AuthWeakPasswordError('Password too short', 400, ['min_length'])
217
+ * ```
218
+ */
102
219
  export class AuthWeakPasswordError extends CustomAuthError {
103
220
  constructor(message, status, reasons) {
104
221
  super(message, 'AuthWeakPasswordError', status, 'weak_password');
@@ -108,6 +225,16 @@ export class AuthWeakPasswordError extends CustomAuthError {
108
225
  export function isAuthWeakPasswordError(error) {
109
226
  return isAuthError(error) && error.name === 'AuthWeakPasswordError';
110
227
  }
228
+ /**
229
+ * Error thrown when a JWT cannot be verified or parsed.
230
+ *
231
+ * @example
232
+ * ```ts
233
+ * import { AuthInvalidJwtError } from '@supabase/auth-js'
234
+ *
235
+ * throw new AuthInvalidJwtError('Token signature is invalid')
236
+ * ```
237
+ */
111
238
  export class AuthInvalidJwtError extends CustomAuthError {
112
239
  constructor(message) {
113
240
  super(message, 'AuthInvalidJwtError', 400, 'invalid_jwt');
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/lib/errors.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,SAAU,SAAQ,KAAK;IAclC,YAAY,OAAe,EAAE,MAAe,EAAE,IAAa;QACzD,KAAK,CAAC,OAAO,CAAC,CAAA;QAHN,kBAAa,GAAG,IAAI,CAAA;QAI5B,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AAED,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,eAAe,IAAI,KAAK,CAAA;AAChF,CAAC;AAED,MAAM,OAAO,YAAa,SAAQ,SAAS;IAGzC,YAAY,OAAe,EAAE,MAAc,EAAE,IAAwB;QACnE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AAED,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,CAAA;AAC5D,CAAC;AAED,MAAM,OAAO,gBAAiB,SAAQ,SAAS;IAG7C,YAAY,OAAe,EAAE,aAAsB;QACjD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAA;QAC9B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACpC,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAI5C,YAAY,OAAe,EAAE,IAAY,EAAE,MAAc,EAAE,IAAwB;QACjF,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAC1D;QACE,KAAK,CAAC,uBAAuB,EAAE,yBAAyB,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;IAC3E,CAAC;CACF;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAU;IAClD,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,yBAAyB,CAAA;AACvE,CAAC;AAED,MAAM,OAAO,6BAA8B,SAAQ,eAAe;IAChE;QACE,KAAK,CAAC,8BAA8B,EAAE,+BAA+B,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;IACxF,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,eAAe;IAC9D,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,6BAA6B,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;IAC/D,CAAC;CACF;AAED,MAAM,OAAO,8BAA+B,SAAQ,eAAe;IAEjE,YAAY,OAAe,EAAE,UAAkD,IAAI;QACjF,KAAK,CAAC,OAAO,EAAE,gCAAgC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;QAFlE,YAAO,GAA2C,IAAI,CAAA;QAGpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;IACH,CAAC;CACF;AAED,MAAM,UAAU,gCAAgC,CAC9C,KAAU;IAEV,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,gCAAgC,CAAA;AAC9E,CAAC;AAED,MAAM,OAAO,8BAA+B,SAAQ,eAAe;IAGjE,YAAY,OAAe,EAAE,UAAkD,IAAI;QACjF,KAAK,CAAC,OAAO,EAAE,gCAAgC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;QAHlE,YAAO,GAA2C,IAAI,CAAA;QAIpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;IACH,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAC1D,YAAY,OAAe,EAAE,MAAc;QACzC,KAAK,CAAC,OAAO,EAAE,yBAAyB,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;IAC9D,CAAC;CACF;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,yBAAyB,CAAA;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IAMxD,YAAY,OAAe,EAAE,MAAc,EAAE,OAA8B;QACzE,KAAK,CAAC,OAAO,EAAE,uBAAuB,EAAE,MAAM,EAAE,eAAe,CAAC,CAAA;QAEhE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,uBAAuB,CAAA;AACrE,CAAC;AAED,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,aAAa,CAAC,CAAA;IAC3D,CAAC;CACF"}
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/lib/errors.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAclC,YAAY,OAAe,EAAE,MAAe,EAAE,IAAa;QACzD,KAAK,CAAC,OAAO,CAAC,CAAA;QAHN,kBAAa,GAAG,IAAI,CAAA;QAI5B,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AAED,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,eAAe,IAAI,KAAK,CAAA;AAChF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAa,SAAQ,SAAS;IAGzC,YAAY,OAAe,EAAE,MAAc,EAAE,IAAwB;QACnE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AAED,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,CAAA;AAC5D,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,gBAAiB,SAAQ,SAAS;IAG7C,YAAY,OAAe,EAAE,aAAsB;QACjD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAA;QAC9B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACpC,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAI5C,YAAY,OAAe,EAAE,IAAY,EAAE,MAAc,EAAE,IAAwB;QACjF,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAC1D;QACE,KAAK,CAAC,uBAAuB,EAAE,yBAAyB,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;IAC3E,CAAC;CACF;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAU;IAClD,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,yBAAyB,CAAA;AACvE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,6BAA8B,SAAQ,eAAe;IAChE;QACE,KAAK,CAAC,8BAA8B,EAAE,+BAA+B,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;IACxF,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,2BAA4B,SAAQ,eAAe;IAC9D,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,6BAA6B,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;IAC/D,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,8BAA+B,SAAQ,eAAe;IAEjE,YAAY,OAAe,EAAE,UAAkD,IAAI;QACjF,KAAK,CAAC,OAAO,EAAE,gCAAgC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;QAFlE,YAAO,GAA2C,IAAI,CAAA;QAGpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;IACH,CAAC;CACF;AAED,MAAM,UAAU,gCAAgC,CAC9C,KAAU;IAEV,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,gCAAgC,CAAA;AAC9E,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,8BAA+B,SAAQ,eAAe;IAGjE,YAAY,OAAe,EAAE,UAAkD,IAAI;QACjF,KAAK,CAAC,OAAO,EAAE,gCAAgC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAA;QAHlE,YAAO,GAA2C,IAAI,CAAA;QAIpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;IACH,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAC1D,YAAY,OAAe,EAAE,MAAc;QACzC,KAAK,CAAC,OAAO,EAAE,yBAAyB,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;IAC9D,CAAC;CACF;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,yBAAyB,CAAA;AACvE,CAAC;AAED;;;;GAIG;AACH;;;;;;;;;GASG;AACH,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IAMxD,YAAY,OAAe,EAAE,MAAc,EAAE,OAA8B;QACzE,KAAK,CAAC,OAAO,EAAE,uBAAuB,EAAE,MAAM,EAAE,eAAe,CAAC,CAAA;QAEhE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,OAAO,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,uBAAuB,CAAA;AACrE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,qBAAqB,EAAE,GAAG,EAAE,aAAa,CAAC,CAAA;IAC3D,CAAC;CACF"}
@@ -11,13 +11,44 @@ export declare const internals: {
11
11
  * An error thrown when a lock cannot be acquired after some amount of time.
12
12
  *
13
13
  * Use the {@link #isAcquireTimeout} property instead of checking with `instanceof`.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * import { LockAcquireTimeoutError } from '@supabase/auth-js'
18
+ *
19
+ * class CustomLockError extends LockAcquireTimeoutError {
20
+ * constructor() {
21
+ * super('Lock timed out')
22
+ * }
23
+ * }
24
+ * ```
14
25
  */
15
26
  export declare abstract class LockAcquireTimeoutError extends Error {
16
27
  readonly isAcquireTimeout = true;
17
28
  constructor(message: string);
18
29
  }
30
+ /**
31
+ * Error thrown when the browser Navigator Lock API fails to acquire a lock.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * import { NavigatorLockAcquireTimeoutError } from '@supabase/auth-js'
36
+ *
37
+ * throw new NavigatorLockAcquireTimeoutError('Lock timed out')
38
+ * ```
39
+ */
19
40
  export declare class NavigatorLockAcquireTimeoutError extends LockAcquireTimeoutError {
20
41
  }
42
+ /**
43
+ * Error thrown when the process-level lock helper cannot acquire a lock.
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * import { ProcessLockAcquireTimeoutError } from '@supabase/auth-js'
48
+ *
49
+ * throw new ProcessLockAcquireTimeoutError('Lock timed out')
50
+ * ```
51
+ */
21
52
  export declare class ProcessLockAcquireTimeoutError extends LockAcquireTimeoutError {
22
53
  }
23
54
  /**
@@ -44,6 +75,12 @@ export declare class ProcessLockAcquireTimeoutError extends LockAcquireTimeoutEr
44
75
  * will time out after so many milliseconds. An error is
45
76
  * a timeout if it has `isAcquireTimeout` set to true.
46
77
  * @param fn The operation to run once the lock is acquired.
78
+ * @example
79
+ * ```ts
80
+ * await navigatorLock('sync-user', 1000, async () => {
81
+ * await refreshSession()
82
+ * })
83
+ * ```
47
84
  */
48
85
  export declare function navigatorLock<R>(name: string, acquireTimeout: number, fn: () => Promise<R>): Promise<R>;
49
86
  /**
@@ -59,6 +96,12 @@ export declare function navigatorLock<R>(name: string, acquireTimeout: number, f
59
96
  * will time out after so many milliseconds. An error is
60
97
  * a timeout if it has `isAcquireTimeout` set to true.
61
98
  * @param fn The operation to run once the lock is acquired.
99
+ * @example
100
+ * ```ts
101
+ * await processLock('migrate', 5000, async () => {
102
+ * await runMigration()
103
+ * })
104
+ * ```
62
105
  */
63
106
  export declare function processLock<R>(name: string, acquireTimeout: number, fn: () => Promise<R>): Promise<R>;
64
107
  //# sourceMappingURL=locks.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"locks.d.ts","sourceRoot":"","sources":["../../../src/lib/locks.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,SAAS;IACpB;;OAEG;;CAOJ,CAAA;AAED;;;;GAIG;AACH,8BAAsB,uBAAwB,SAAQ,KAAK;IACzD,SAAgB,gBAAgB,QAAO;gBAE3B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,gCAAiC,SAAQ,uBAAuB;CAAG;AAChF,qBAAa,8BAA+B,SAAQ,uBAAuB;CAAG;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,aAAa,CAAC,CAAC,EACnC,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACnB,OAAO,CAAC,CAAC,CAAC,CA0FZ;AAID;;;;;;;;;;;;;GAaG;AACH,wBAAsB,WAAW,CAAC,CAAC,EACjC,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACnB,OAAO,CAAC,CAAC,CAAC,CAkDZ"}
1
+ {"version":3,"file":"locks.d.ts","sourceRoot":"","sources":["../../../src/lib/locks.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,SAAS;IACpB;;OAEG;;CAOJ,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,uBAAwB,SAAQ,KAAK;IACzD,SAAgB,gBAAgB,QAAO;gBAE3B,OAAO,EAAE,MAAM;CAG5B;AAED;;;;;;;;;GASG;AACH,qBAAa,gCAAiC,SAAQ,uBAAuB;CAAG;AAChF;;;;;;;;;GASG;AACH,qBAAa,8BAA+B,SAAQ,uBAAuB;CAAG;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,aAAa,CAAC,CAAC,EACnC,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACnB,OAAO,CAAC,CAAC,CAAC,CA0FZ;AAID;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,WAAW,CAAC,CAAC,EACjC,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACnB,OAAO,CAAC,CAAC,CAAC,CAkDZ"}
@@ -15,6 +15,17 @@ export const internals = {
15
15
  * An error thrown when a lock cannot be acquired after some amount of time.
16
16
  *
17
17
  * Use the {@link #isAcquireTimeout} property instead of checking with `instanceof`.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * import { LockAcquireTimeoutError } from '@supabase/auth-js'
22
+ *
23
+ * class CustomLockError extends LockAcquireTimeoutError {
24
+ * constructor() {
25
+ * super('Lock timed out')
26
+ * }
27
+ * }
28
+ * ```
18
29
  */
19
30
  export class LockAcquireTimeoutError extends Error {
20
31
  constructor(message) {
@@ -22,8 +33,28 @@ export class LockAcquireTimeoutError extends Error {
22
33
  this.isAcquireTimeout = true;
23
34
  }
24
35
  }
36
+ /**
37
+ * Error thrown when the browser Navigator Lock API fails to acquire a lock.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * import { NavigatorLockAcquireTimeoutError } from '@supabase/auth-js'
42
+ *
43
+ * throw new NavigatorLockAcquireTimeoutError('Lock timed out')
44
+ * ```
45
+ */
25
46
  export class NavigatorLockAcquireTimeoutError extends LockAcquireTimeoutError {
26
47
  }
48
+ /**
49
+ * Error thrown when the process-level lock helper cannot acquire a lock.
50
+ *
51
+ * @example
52
+ * ```ts
53
+ * import { ProcessLockAcquireTimeoutError } from '@supabase/auth-js'
54
+ *
55
+ * throw new ProcessLockAcquireTimeoutError('Lock timed out')
56
+ * ```
57
+ */
27
58
  export class ProcessLockAcquireTimeoutError extends LockAcquireTimeoutError {
28
59
  }
29
60
  /**
@@ -50,6 +81,12 @@ export class ProcessLockAcquireTimeoutError extends LockAcquireTimeoutError {
50
81
  * will time out after so many milliseconds. An error is
51
82
  * a timeout if it has `isAcquireTimeout` set to true.
52
83
  * @param fn The operation to run once the lock is acquired.
84
+ * @example
85
+ * ```ts
86
+ * await navigatorLock('sync-user', 1000, async () => {
87
+ * await refreshSession()
88
+ * })
89
+ * ```
53
90
  */
54
91
  export async function navigatorLock(name, acquireTimeout, fn) {
55
92
  if (internals.debug) {
@@ -135,6 +172,12 @@ const PROCESS_LOCKS = {};
135
172
  * will time out after so many milliseconds. An error is
136
173
  * a timeout if it has `isAcquireTimeout` set to true.
137
174
  * @param fn The operation to run once the lock is acquired.
175
+ * @example
176
+ * ```ts
177
+ * await processLock('migrate', 5000, async () => {
178
+ * await runMigration()
179
+ * })
180
+ * ```
138
181
  */
139
182
  export async function processLock(name, acquireTimeout, fn) {
140
183
  var _a;
@@ -1 +1 @@
1
- {"version":3,"file":"locks.js","sourceRoot":"","sources":["../../../src/lib/locks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AAEhD;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,CACP,UAAU;QACV,oBAAoB,EAAE;QACtB,UAAU,CAAC,YAAY;QACvB,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,gCAAgC,CAAC,KAAK,MAAM,CAC7E;CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,KAAK;IAGzD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAA;QAHA,qBAAgB,GAAG,IAAI,CAAA;IAIvC,CAAC;CACF;AAED,MAAM,OAAO,gCAAiC,SAAQ,uBAAuB;CAAG;AAChF,MAAM,OAAO,8BAA+B,SAAQ,uBAAuB;CAAG;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,IAAY,EACZ,cAAsB,EACtB,EAAoB;IAEpB,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,kDAAkD,EAAE,IAAI,EAAE,cAAc,CAAC,CAAA;IACvF,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,eAAe,EAAE,CAAA;IAExD,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;QACvB,UAAU,CAAC,GAAG,EAAE;YACd,eAAe,CAAC,KAAK,EAAE,CAAA;YACvB,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;gBACpB,OAAO,CAAC,GAAG,CAAC,sDAAsD,EAAE,IAAI,CAAC,CAAA;YAC3E,CAAC;QACH,CAAC,EAAE,cAAc,CAAC,CAAA;IACpB,CAAC;IAED,oFAAoF;IAEpF,0EAA0E;IAC1E,yEAAyE;IACzE,0EAA0E;IAC1E,2EAA2E;IAC3E,6EAA6E;IAC7E,wEAAwE;IACxE,UAAU;IACV,OAAO,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CACvC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAChC,IAAI,EACJ,cAAc,KAAK,CAAC;QAClB,CAAC,CAAC;YACE,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,IAAI;SAClB;QACH,CAAC,CAAC;YACE,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,eAAe,CAAC,MAAM;SAC/B,EACL,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;gBACpB,OAAO,CAAC,GAAG,CAAC,8CAA8C,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;YAC9E,CAAC;YAED,IAAI,CAAC;gBACH,OAAO,MAAM,EAAE,EAAE,CAAA;YACnB,CAAC;oBAAS,CAAC;gBACT,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;oBACpB,OAAO,CAAC,GAAG,CAAC,8CAA8C,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;gBAC9E,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;gBACzB,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;oBACpB,OAAO,CAAC,GAAG,CAAC,+DAA+D,EAAE,IAAI,CAAC,CAAA;gBACpF,CAAC;gBAED,MAAM,IAAI,gCAAgC,CACxC,sDAAsD,IAAI,sBAAsB,CACjF,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;oBACpB,IAAI,CAAC;wBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;wBAEvD,OAAO,CAAC,GAAG,CACT,kDAAkD,EAClD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CACnC,CAAA;oBACH,CAAC;oBAAC,OAAO,CAAM,EAAE,CAAC;wBAChB,OAAO,CAAC,IAAI,CACV,sEAAsE,EACtE,CAAC,CACF,CAAA;oBACH,CAAC;gBACH,CAAC;gBAED,8DAA8D;gBAC9D,iEAAiE;gBACjE,qEAAqE;gBACrE,iDAAiD;gBACjD,OAAO,CAAC,IAAI,CACV,yPAAyP,CAC1P,CAAA;gBAED,OAAO,MAAM,EAAE,EAAE,CAAA;YACnB,CAAC;QACH,CAAC;IACH,CAAC,CACF,CACF,CAAA;AACH,CAAC;AAED,MAAM,aAAa,GAAqC,EAAE,CAAA;AAE1D;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,IAAY,EACZ,cAAsB,EACtB,EAAoB;;IAEpB,MAAM,iBAAiB,GAAG,MAAA,aAAa,CAAC,IAAI,CAAC,mCAAI,OAAO,CAAC,OAAO,EAAE,CAAA;IAElE,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CACnC;QACE,iBAAiB,CAAC,KAAK,CAAC,GAAG,EAAE;YAC3B,kEAAkE;YAClE,OAAO,IAAI,CAAA;QACb,CAAC,CAAC;QACF,cAAc,IAAI,CAAC;YACjB,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;gBACxB,UAAU,CAAC,GAAG,EAAE;oBACd,MAAM,CACJ,IAAI,8BAA8B,CAChC,oCAAoC,IAAI,aAAa,CACtD,CACF,CAAA;gBACH,CAAC,EAAE,cAAc,CAAC,CAAA;YACpB,CAAC,CAAC;YACJ,CAAC,CAAC,IAAI;KACT,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CACnB;SACE,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE;QAChB,IAAI,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAC5B,MAAM,CAAC,CAAA;QACT,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC,CAAC;SACD,IAAI,CAAC,KAAK,IAAI,EAAE;QACf,uEAAuE;QACvE,sDAAsD;QACtD,OAAO,MAAM,EAAE,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IAEJ,aAAa,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,EAAE,CAAM,EAAE,EAAE;QAC5D,IAAI,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAC5B,wEAAwE;YACxE,kEAAkE;YAClE,MAAM,iBAAiB,CAAA;YAEvB,OAAO,IAAI,CAAA;QACb,CAAC;QAED,MAAM,CAAC,CAAA;IACT,CAAC,CAAC,CAAA;IAEF,yEAAyE;IACzE,yCAAyC;IACzC,OAAO,MAAM,gBAAgB,CAAA;AAC/B,CAAC"}
1
+ {"version":3,"file":"locks.js","sourceRoot":"","sources":["../../../src/lib/locks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AAEhD;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,CACP,UAAU;QACV,oBAAoB,EAAE;QACtB,UAAU,CAAC,YAAY;QACvB,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,gCAAgC,CAAC,KAAK,MAAM,CAC7E;CACF,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,KAAK;IAGzD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAA;QAHA,qBAAgB,GAAG,IAAI,CAAA;IAIvC,CAAC;CACF;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,gCAAiC,SAAQ,uBAAuB;CAAG;AAChF;;;;;;;;;GASG;AACH,MAAM,OAAO,8BAA+B,SAAQ,uBAAuB;CAAG;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,IAAY,EACZ,cAAsB,EACtB,EAAoB;IAEpB,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,kDAAkD,EAAE,IAAI,EAAE,cAAc,CAAC,CAAA;IACvF,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,eAAe,EAAE,CAAA;IAExD,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;QACvB,UAAU,CAAC,GAAG,EAAE;YACd,eAAe,CAAC,KAAK,EAAE,CAAA;YACvB,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;gBACpB,OAAO,CAAC,GAAG,CAAC,sDAAsD,EAAE,IAAI,CAAC,CAAA;YAC3E,CAAC;QACH,CAAC,EAAE,cAAc,CAAC,CAAA;IACpB,CAAC;IAED,oFAAoF;IAEpF,0EAA0E;IAC1E,yEAAyE;IACzE,0EAA0E;IAC1E,2EAA2E;IAC3E,6EAA6E;IAC7E,wEAAwE;IACxE,UAAU;IACV,OAAO,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CACvC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAChC,IAAI,EACJ,cAAc,KAAK,CAAC;QAClB,CAAC,CAAC;YACE,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,IAAI;SAClB;QACH,CAAC,CAAC;YACE,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,eAAe,CAAC,MAAM;SAC/B,EACL,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;gBACpB,OAAO,CAAC,GAAG,CAAC,8CAA8C,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;YAC9E,CAAC;YAED,IAAI,CAAC;gBACH,OAAO,MAAM,EAAE,EAAE,CAAA;YACnB,CAAC;oBAAS,CAAC;gBACT,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;oBACpB,OAAO,CAAC,GAAG,CAAC,8CAA8C,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;gBAC9E,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;gBACzB,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;oBACpB,OAAO,CAAC,GAAG,CAAC,+DAA+D,EAAE,IAAI,CAAC,CAAA;gBACpF,CAAC;gBAED,MAAM,IAAI,gCAAgC,CACxC,sDAAsD,IAAI,sBAAsB,CACjF,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;oBACpB,IAAI,CAAC;wBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;wBAEvD,OAAO,CAAC,GAAG,CACT,kDAAkD,EAClD,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CACnC,CAAA;oBACH,CAAC;oBAAC,OAAO,CAAM,EAAE,CAAC;wBAChB,OAAO,CAAC,IAAI,CACV,sEAAsE,EACtE,CAAC,CACF,CAAA;oBACH,CAAC;gBACH,CAAC;gBAED,8DAA8D;gBAC9D,iEAAiE;gBACjE,qEAAqE;gBACrE,iDAAiD;gBACjD,OAAO,CAAC,IAAI,CACV,yPAAyP,CAC1P,CAAA;gBAED,OAAO,MAAM,EAAE,EAAE,CAAA;YACnB,CAAC;QACH,CAAC;IACH,CAAC,CACF,CACF,CAAA;AACH,CAAC;AAED,MAAM,aAAa,GAAqC,EAAE,CAAA;AAE1D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,IAAY,EACZ,cAAsB,EACtB,EAAoB;;IAEpB,MAAM,iBAAiB,GAAG,MAAA,aAAa,CAAC,IAAI,CAAC,mCAAI,OAAO,CAAC,OAAO,EAAE,CAAA;IAElE,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CACnC;QACE,iBAAiB,CAAC,KAAK,CAAC,GAAG,EAAE;YAC3B,kEAAkE;YAClE,OAAO,IAAI,CAAA;QACb,CAAC,CAAC;QACF,cAAc,IAAI,CAAC;YACjB,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;gBACxB,UAAU,CAAC,GAAG,EAAE;oBACd,MAAM,CACJ,IAAI,8BAA8B,CAChC,oCAAoC,IAAI,aAAa,CACtD,CACF,CAAA;gBACH,CAAC,EAAE,cAAc,CAAC,CAAA;YACpB,CAAC,CAAC;YACJ,CAAC,CAAC,IAAI;KACT,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CACnB;SACE,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE;QAChB,IAAI,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAC5B,MAAM,CAAC,CAAA;QACT,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC,CAAC;SACD,IAAI,CAAC,KAAK,IAAI,EAAE;QACf,uEAAuE;QACvE,sDAAsD;QACtD,OAAO,MAAM,EAAE,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IAEJ,aAAa,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,EAAE,CAAM,EAAE,EAAE;QAC5D,IAAI,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAC5B,wEAAwE;YACxE,kEAAkE;YAClE,MAAM,iBAAiB,CAAA;YAEvB,OAAO,IAAI,CAAA;QACb,CAAC;QAED,MAAM,CAAC,CAAA;IACT,CAAC,CAAC,CAAA;IAEF,yEAAyE;IACzE,yCAAyC;IACzC,OAAO,MAAM,gBAAgB,CAAA;AAC/B,CAAC"}
@@ -1,2 +1,2 @@
1
- export declare const version = "2.81.1";
1
+ export declare const version = "2.81.2-canary.1";
2
2
  //# sourceMappingURL=version.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,WAAW,CAAA"}
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}
@@ -4,5 +4,5 @@
4
4
  // - Debugging and support (identifying which version is running)
5
5
  // - Telemetry and logging (version reporting in errors/analytics)
6
6
  // - Ensuring build artifacts match the published package version
7
- export const version = '2.81.1';
7
+ export const version = '2.81.2-canary.1';
8
8
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACjE,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAA"}
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACjE,MAAM,CAAC,MAAM,OAAO,GAAG,iBAAiB,CAAA"}