@koolbase/js 12.1.0 → 12.3.0

package/CHANGELOG.md

@@ -7,6 +7,21 @@ is based on [Keep a Changelog][kac], and this project adheres to
 [kac]: https://keepachangelog.com/en/1.1.0/
 [semver]: https://semver.org/
 
+## 12.2.0
+
+### Added
+
+- **Two-step sign-in (MFA).** Every sign-in method now throws `MfaRequiredError`
+  carrying a `challengeToken` when the person's account has an authenticator on
+  — including phone, Google and Apple, whose error parsers all map it, enforced
+  by a source test for any parser added later. `verifyMfa({ challengeToken, code
+  })` and `verifyRecoveryCode({ challengeToken, code })` finish sign-in and
+  store the session, returning `{ session, recoveryCodesRemaining }` for the
+  latter.
+- `enrollMfa()`, `confirmMfaEnrollment(code)`, `mfaStatus()`, `stepUpMfa(…)`,
+  `disableMfa()`, and `regenerateRecoveryCodes()` manage it. Six new error
+  classes in the mapping table and fidelity list.
+
 ## 12.1.0
 
 ### Added

package/README.md

@@ -98,6 +98,22 @@ If your app needs a different trade-off — an httpOnly cookie set by your own
 backend, say — implement `KoolbaseAuthStorage` and pass it as
 `config.authStorage`. The SDK will use yours instead of its own.
 
+### Two-step sign-in (MFA)
+
+```typescript
+// After login() throws MfaRequiredError:
+const session = await Koolbase.auth.verifyMfa({
+  challengeToken: err.challengeToken,
+  code: '123456',  // from the person's authenticator app
+});
+
+// Enrol (within 10 minutes of signing in):
+const { otpauthUri, secret } = await Koolbase.auth.enrollMfa();
+// show otpauthUri as a QR code, then:
+const codes = await Koolbase.auth.confirmMfaEnrollment('123456');
+// save the recovery codes — shown this once only
+```
+
 ### Email code
 
 ```typescript

package/dist/cjs/platform.js

@@ -137,10 +137,14 @@ function makeResolver() {
                 if (await probe(s))
                     return { tier: 'localstorage', store: s };
             }
+            // Outside a browser (Node, a server rendering pages) memory is the
+            // expected store, not a symptom, so there is nothing to warn about.
+            const inBrowser = typeof window !== 'undefined' && typeof document !== 'undefined';
             // eslint-disable-next-line no-console
-            console.warn('[Koolbase] No persistent storage available in this browser ' +
-                '(private browsing, blocked site data, or an exhausted quota). ' +
-                'The session and the offline queue will not survive a reload.');
+            if (inBrowser)
+                console.warn('[Koolbase] No persistent storage available in this browser ' +
+                    '(private browsing, blocked site data, or an exhausted quota). ' +
+                    'The session and the offline queue will not survive a reload.');
             return { tier: 'memory', store: memoryStorage() };
         })());
         return resolving.then((r) => { resolved = r; return r; });

package/dist/esm/platform.js

@@ -134,10 +134,14 @@ function makeResolver() {
                 if (await probe(s))
                     return { tier: 'localstorage', store: s };
             }
+            // Outside a browser (Node, a server rendering pages) memory is the
+            // expected store, not a symptom, so there is nothing to warn about.
+            const inBrowser = typeof window !== 'undefined' && typeof document !== 'undefined';
             // eslint-disable-next-line no-console
-            console.warn('[Koolbase] No persistent storage available in this browser ' +
-                '(private browsing, blocked site data, or an exhausted quota). ' +
-                'The session and the offline queue will not survive a reload.');
+            if (inBrowser)
+                console.warn('[Koolbase] No persistent storage available in this browser ' +
+                    '(private browsing, blocked site data, or an exhausted quota). ' +
+                    'The session and the offline queue will not survive a reload.');
             return { tier: 'memory', store: memoryStorage() };
         })());
         return resolving.then((r) => { resolved = r; return r; });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@koolbase/js",
-  "version": "12.1.0",
-  "description": "Koolbase SDK for the browser \u2014 auth, database, storage, realtime, functions, flags and offline sync in one package.",
+  "version": "12.3.0",
+  "description": "Koolbase SDK for the browser — auth, database, storage, realtime, functions, flags and offline sync in one package.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/esm/index.d.ts",
   "files": [
@@ -25,7 +25,7 @@
     "url": "https://github.com/koolbase/koolbase-react-native"
   },
   "dependencies": {
-    "@koolbase/core": "12.1.0"
+    "@koolbase/core": "12.3.0"
   },
   "publishConfig": {
     "access": "public"