@koolbase/js 10.3.0 → 11.0.0
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.
- package/CHANGELOG.md +80 -0
- package/dist/cjs/index.js +33 -12
- package/dist/esm/index.js +33 -12
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,86 @@ is based on [Keep a Changelog][kac], and this project adheres to
|
|
|
7
7
|
[kac]: https://keepachangelog.com/en/1.1.0/
|
|
8
8
|
[semver]: https://semver.org/
|
|
9
9
|
|
|
10
|
+
## 11.0.0
|
|
11
|
+
|
|
12
|
+
### Read before upgrading
|
|
13
|
+
|
|
14
|
+
**`register()` returns a result, not a user.** One line changes in your app,
|
|
15
|
+
and the reason is a bug this fixes.
|
|
16
|
+
|
|
17
|
+
Registration succeeding and authentication succeeding are different outcomes.
|
|
18
|
+
A project with `require_verified_contact` enabled creates the account and
|
|
19
|
+
issues **no session** — the user verifies their email before their first
|
|
20
|
+
sign-in. The server has always answered that case correctly: 201 with
|
|
21
|
+
`verification_required`, deliberately not an error, because reporting failure
|
|
22
|
+
for a signup that worked is worse than either alternative.
|
|
23
|
+
|
|
24
|
+
The SDK ignored that field. It built a session from a response body with no
|
|
25
|
+
tokens in it, persisted it, and answered `currentUser` with a user whose every
|
|
26
|
+
authenticated request went out as `Bearer undefined` and came back 401 —
|
|
27
|
+
signed in as far as the app could tell, and unable to do anything. Silent, and
|
|
28
|
+
only in the configuration that requires verification.
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
// Before
|
|
32
|
+
const user = await Koolbase.auth.register({ email, password });
|
|
33
|
+
|
|
34
|
+
// After
|
|
35
|
+
const result = await Koolbase.auth.register({ email, password });
|
|
36
|
+
switch (result.status) {
|
|
37
|
+
case 'authenticated':
|
|
38
|
+
// result.session is live, the user is signed in
|
|
39
|
+
break;
|
|
40
|
+
case 'verification_required':
|
|
41
|
+
// the account exists, result.session is null, they verify first
|
|
42
|
+
break;
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
A discriminated union rather than a nullable session, so there is no path
|
|
47
|
+
where an app reads `result.user` and assumes it is signed in. That is how the
|
|
48
|
+
bug worked, and a nullable field would have allowed it at one remove.
|
|
49
|
+
|
|
50
|
+
### Fixed
|
|
51
|
+
|
|
52
|
+
- **A session is never fabricated from a response without tokens.** Every
|
|
53
|
+
path that builds one — register, login, refresh, Google, Apple — now refuses
|
|
54
|
+
a body claiming authentication while omitting a token, throwing
|
|
55
|
+
`MalformedSessionResponseError`. Distinct from `verification_required`,
|
|
56
|
+
which is a legitimate session-less success: this is a protocol violation and
|
|
57
|
+
says so.
|
|
58
|
+
|
|
59
|
+
- **A pending signup no longer touches existing state.** It persists nothing,
|
|
60
|
+
fires no auth-state change, and leaves a session already on the device
|
|
61
|
+
alone — registering a second account does not sign out the first.
|
|
62
|
+
|
|
63
|
+
### Migration
|
|
64
|
+
|
|
65
|
+
Assign the result, switch on `status`. If your project does not require
|
|
66
|
+
verified contact, the `authenticated` branch is the only one you will see —
|
|
67
|
+
but write both, because turning that setting on later should not break your
|
|
68
|
+
signup flow.
|
|
69
|
+
|
|
70
|
+
## 10.4.0
|
|
71
|
+
|
|
72
|
+
### Added
|
|
73
|
+
|
|
74
|
+
- **`auth.verifyEmail(token)`** — complete email verification with a token
|
|
75
|
+
from a verification link. The endpoint and the Flutter SDK have had this;
|
|
76
|
+
the TypeScript SDKs did not, so an app's verify-email page had nothing to
|
|
77
|
+
call.
|
|
78
|
+
|
|
79
|
+
- **`auth.resendVerificationEmail()`** — re-send the verification email to a
|
|
80
|
+
signed-in but unverified user. Returns `{ alreadyVerified, expiresAt,
|
|
81
|
+
cooldownUntil }`; an already-verified account is a no-op that says so
|
|
82
|
+
rather than an error, which is what a resend button needs when the user
|
|
83
|
+
verified in another tab.
|
|
84
|
+
|
|
85
|
+
The server throttles this, and the refusal now arrives typed:
|
|
86
|
+
`VerificationResendCooldownError` carries `cooldownUntil` so you can show a
|
|
87
|
+
countdown, and `VerificationResendDailyCapError` is separate because the
|
|
88
|
+
remedy differs — wait seconds versus wait until tomorrow.
|
|
89
|
+
|
|
10
90
|
## 10.3.0
|
|
11
91
|
|
|
12
92
|
### Fixed
|
package/dist/cjs/index.js
CHANGED
|
@@ -38,6 +38,15 @@ let _functions = null;
|
|
|
38
38
|
let _flags = null;
|
|
39
39
|
let _analytics = null;
|
|
40
40
|
let _initialized = false;
|
|
41
|
+
// The in-flight initialize, so overlapping callers await the same one.
|
|
42
|
+
//
|
|
43
|
+
// A boolean guard is not enough: the check happens before the first await
|
|
44
|
+
// and the flag is set after the last, so two calls that overlap in that
|
|
45
|
+
// window both pass and both build a whole SDK — two of every client, two
|
|
46
|
+
// analytics flush timers, two sync engines over one queue. React strict
|
|
47
|
+
// mode does exactly this in development, and so does any app that
|
|
48
|
+
// initializes from two components.
|
|
49
|
+
let _initializing = null;
|
|
41
50
|
function ensureInitialized() {
|
|
42
51
|
if (!_initialized) {
|
|
43
52
|
throw new Error('Koolbase not initialized. Call Koolbase.initialize(config) first.');
|
|
@@ -47,19 +56,31 @@ exports.Koolbase = {
|
|
|
47
56
|
async initialize(config) {
|
|
48
57
|
if (_initialized)
|
|
49
58
|
return;
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
59
|
+
if (_initializing)
|
|
60
|
+
return _initializing;
|
|
61
|
+
_initializing = (async () => {
|
|
62
|
+
(0, core_1.setPlatform)(config.platform ?? (0, platform_js_2.browserPlatform)());
|
|
63
|
+
_auth = new core_1.KoolbaseAuth(config);
|
|
64
|
+
_db = new core_1.KoolbaseDatabase(config, () => _auth?.currentUser?.id ?? null, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
|
|
65
|
+
_storage = new core_1.KoolbaseStorage(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
|
|
66
|
+
_realtime = new core_1.KoolbaseRealtime(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), () => _auth?.currentUser?.id ?? null);
|
|
67
|
+
_functions = new core_1.KoolbaseFunctions(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
|
|
68
|
+
const deviceId = await (0, core_1.getOrCreateDeviceId)();
|
|
69
|
+
_flags = new core_1.KoolbaseFlags(config, deviceId);
|
|
70
|
+
if (config.analyticsEnabled !== false) {
|
|
71
|
+
_analytics = new core_1.KoolbaseAnalytics(config, () => _auth?.currentUser?.id ?? null);
|
|
72
|
+
await _analytics.init(config.appVersion);
|
|
73
|
+
}
|
|
74
|
+
_initialized = true;
|
|
75
|
+
})();
|
|
76
|
+
try {
|
|
77
|
+
await _initializing;
|
|
78
|
+
}
|
|
79
|
+
finally {
|
|
80
|
+
// Cleared either way: a failed initialize must be retryable rather
|
|
81
|
+
// than leaving every later caller awaiting a rejected promise.
|
|
82
|
+
_initializing = null;
|
|
61
83
|
}
|
|
62
|
-
_initialized = true;
|
|
63
84
|
},
|
|
64
85
|
get auth() { ensureInitialized(); return _auth; },
|
|
65
86
|
get db() { ensureInitialized(); return _db; },
|
package/dist/esm/index.js
CHANGED
|
@@ -19,6 +19,15 @@ let _functions = null;
|
|
|
19
19
|
let _flags = null;
|
|
20
20
|
let _analytics = null;
|
|
21
21
|
let _initialized = false;
|
|
22
|
+
// The in-flight initialize, so overlapping callers await the same one.
|
|
23
|
+
//
|
|
24
|
+
// A boolean guard is not enough: the check happens before the first await
|
|
25
|
+
// and the flag is set after the last, so two calls that overlap in that
|
|
26
|
+
// window both pass and both build a whole SDK — two of every client, two
|
|
27
|
+
// analytics flush timers, two sync engines over one queue. React strict
|
|
28
|
+
// mode does exactly this in development, and so does any app that
|
|
29
|
+
// initializes from two components.
|
|
30
|
+
let _initializing = null;
|
|
22
31
|
function ensureInitialized() {
|
|
23
32
|
if (!_initialized) {
|
|
24
33
|
throw new Error('Koolbase not initialized. Call Koolbase.initialize(config) first.');
|
|
@@ -28,19 +37,31 @@ export const Koolbase = {
|
|
|
28
37
|
async initialize(config) {
|
|
29
38
|
if (_initialized)
|
|
30
39
|
return;
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
40
|
+
if (_initializing)
|
|
41
|
+
return _initializing;
|
|
42
|
+
_initializing = (async () => {
|
|
43
|
+
setPlatform(config.platform ?? browserPlatform());
|
|
44
|
+
_auth = new KoolbaseAuth(config);
|
|
45
|
+
_db = new KoolbaseDatabase(config, () => _auth?.currentUser?.id ?? null, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
|
|
46
|
+
_storage = new KoolbaseStorage(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
|
|
47
|
+
_realtime = new KoolbaseRealtime(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), () => _auth?.currentUser?.id ?? null);
|
|
48
|
+
_functions = new KoolbaseFunctions(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
|
|
49
|
+
const deviceId = await getOrCreateDeviceId();
|
|
50
|
+
_flags = new KoolbaseFlags(config, deviceId);
|
|
51
|
+
if (config.analyticsEnabled !== false) {
|
|
52
|
+
_analytics = new KoolbaseAnalytics(config, () => _auth?.currentUser?.id ?? null);
|
|
53
|
+
await _analytics.init(config.appVersion);
|
|
54
|
+
}
|
|
55
|
+
_initialized = true;
|
|
56
|
+
})();
|
|
57
|
+
try {
|
|
58
|
+
await _initializing;
|
|
59
|
+
}
|
|
60
|
+
finally {
|
|
61
|
+
// Cleared either way: a failed initialize must be retryable rather
|
|
62
|
+
// than leaving every later caller awaiting a rejected promise.
|
|
63
|
+
_initializing = null;
|
|
42
64
|
}
|
|
43
|
-
_initialized = true;
|
|
44
65
|
},
|
|
45
66
|
get auth() { ensureInitialized(); return _auth; },
|
|
46
67
|
get db() { ensureInitialized(); return _db; },
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@koolbase/js",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "11.0.0",
|
|
4
4
|
"description": "Koolbase SDK for the browser \u2014 auth, database, storage, realtime, functions, flags and offline sync in one package.",
|
|
5
5
|
"main": "./dist/cjs/index.js",
|
|
6
6
|
"types": "./dist/esm/index.d.ts",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"url": "https://github.com/koolbase/koolbase-react-native"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@koolbase/core": "
|
|
28
|
+
"@koolbase/core": "11.0.0"
|
|
29
29
|
},
|
|
30
30
|
"publishConfig": {
|
|
31
31
|
"access": "public"
|