@koolbase/js 12.0.0 → 12.2.0

package/CHANGELOG.md

@@ -7,6 +7,48 @@ 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
+
+- **Sign in with an emailed code.** `auth.requestEmailCode({ email })` sends a
+  six-digit code; `auth.signInWithEmailCode({ email, code })` signs in and
+  stores the session exactly as `login()` does. An unknown address becomes an
+  account only while the project accepts sign-ups. Each code works once and
+  allows three attempts. The request resolves the same way whether or not the
+  address has an account. A project can switch this off; requests then throw
+  `EmailCodeDisabledError`.
+- **Fiscal.** `KoolbaseFiscal` with `submit()` and `status()`, and
+  `KoolbaseFiscalError`. A timeout on `submit` means poll `status()` with the
+  same `clientRef` — do not submit again, or the sale may be recorded twice.
+- **Reference errors are catchable.** `KoolbaseReferenceInvalidError`,
+  `KoolbaseReferenceInUseError`, `KoolbaseDanglingReferencesError` (carrying
+  the offending records) and `KoolbaseCollectionReferencedError`.
+
+### Changed
+
+- The OTP errors (`OtpInvalidError`, `OtpExpiredError`,
+  `OtpMaxAttemptsError`) now come from the shared error mapping, so every path
+  that returns them throws the class an app catches.
+- `oauthLogin()`'s deprecation now points to `signInWithGoogle()` and
+  `signInWithApple()`. It said OAuth was not yet shipped and to use email and
+  password instead, which had long stopped being true.
+
 ## 12.0.0
 
 ### Breaking

package/README.md

@@ -98,6 +98,33 @@ 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
+await Koolbase.auth.requestEmailCode({ email: 'user@example.com' });
+await Koolbase.auth.signInWithEmailCode({ email: 'user@example.com', code: '123456' });
+```
+
+A new address becomes an account only while sign-ups are open. Each code works
+once, allows three attempts, and expires after ten minutes. Projects can switch
+this off in auth settings.
+
 ### Phone + OTP
 
 ```typescript

package/dist/cjs/index.d.ts

@@ -1,12 +1,13 @@
 export * from '@koolbase/core';
 export { BrowserAuthStorage } from './auth-storage.js';
 export { browserPlatform } from './platform.js';
-import { KoolbaseAuth, KoolbaseDatabase, KoolbaseStorage, KoolbaseRealtime, KoolbaseFunctions, KoolbaseAnalytics, type KoolbaseConfig, type VersionCheckResult } from '@koolbase/core';
+import { KoolbaseAuth, KoolbaseDatabase, KoolbaseFiscal, KoolbaseStorage, KoolbaseRealtime, KoolbaseFunctions, KoolbaseAnalytics, type KoolbaseConfig, type VersionCheckResult } from '@koolbase/core';
 export declare const Koolbase: {
     initialize(config: KoolbaseConfig): Promise<void>;
     readonly auth: KoolbaseAuth;
     readonly db: KoolbaseDatabase;
     readonly storage: KoolbaseStorage;
+    readonly fiscal: KoolbaseFiscal;
     readonly realtime: KoolbaseRealtime;
     readonly functions: KoolbaseFunctions;
     readonly analytics: KoolbaseAnalytics;

package/dist/cjs/index.js

@@ -33,6 +33,7 @@ const platform_js_2 = require("./platform.js");
 let _auth = null;
 let _db = null;
 let _storage = null;
+let _fiscal = null;
 let _realtime = null;
 let _functions = null;
 let _flags = null;
@@ -63,6 +64,7 @@ exports.Koolbase = {
             _auth = new core_1.KoolbaseAuth(config);
             _db = new core_1.KoolbaseDatabase(config, () => _auth?.currentUser?.id ?? null, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
             _storage = new core_1.KoolbaseStorage(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
+            _fiscal = new core_1.KoolbaseFiscal(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
             _realtime = new core_1.KoolbaseRealtime(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), () => _auth?.currentUser?.id ?? null);
             _functions = new core_1.KoolbaseFunctions(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
             const deviceId = await (0, core_1.getOrCreateDeviceId)();
@@ -85,6 +87,7 @@ exports.Koolbase = {
     get auth() { ensureInitialized(); return _auth; },
     get db() { ensureInitialized(); return _db; },
     get storage() { ensureInitialized(); return _storage; },
+    get fiscal() { ensureInitialized(); return _fiscal; },
     get realtime() { ensureInitialized(); return _realtime; },
     get functions() { ensureInitialized(); return _functions; },
     get analytics() {

package/dist/esm/index.d.ts

@@ -1,12 +1,13 @@
 export * from '@koolbase/core';
 export { BrowserAuthStorage } from './auth-storage.js';
 export { browserPlatform } from './platform.js';
-import { KoolbaseAuth, KoolbaseDatabase, KoolbaseStorage, KoolbaseRealtime, KoolbaseFunctions, KoolbaseAnalytics, type KoolbaseConfig, type VersionCheckResult } from '@koolbase/core';
+import { KoolbaseAuth, KoolbaseDatabase, KoolbaseFiscal, KoolbaseStorage, KoolbaseRealtime, KoolbaseFunctions, KoolbaseAnalytics, type KoolbaseConfig, type VersionCheckResult } from '@koolbase/core';
 export declare const Koolbase: {
     initialize(config: KoolbaseConfig): Promise<void>;
     readonly auth: KoolbaseAuth;
     readonly db: KoolbaseDatabase;
     readonly storage: KoolbaseStorage;
+    readonly fiscal: KoolbaseFiscal;
     readonly realtime: KoolbaseRealtime;
     readonly functions: KoolbaseFunctions;
     readonly analytics: KoolbaseAnalytics;

package/dist/esm/index.js

@@ -9,11 +9,12 @@
 export * from '@koolbase/core';
 export { BrowserAuthStorage } from './auth-storage.js';
 export { browserPlatform } from './platform.js';
-import { KoolbaseAuth, KoolbaseDatabase, KoolbaseStorage, KoolbaseRealtime, KoolbaseFunctions, KoolbaseFlags, KoolbaseAnalytics, getOrCreateDeviceId, setPlatform, } from '@koolbase/core';
+import { KoolbaseAuth, KoolbaseDatabase, KoolbaseFiscal, KoolbaseStorage, KoolbaseRealtime, KoolbaseFunctions, KoolbaseFlags, KoolbaseAnalytics, getOrCreateDeviceId, setPlatform, } from '@koolbase/core';
 import { browserPlatform } from './platform.js';
 let _auth = null;
 let _db = null;
 let _storage = null;
+let _fiscal = null;
 let _realtime = null;
 let _functions = null;
 let _flags = null;
@@ -44,6 +45,7 @@ export const Koolbase = {
             _auth = new KoolbaseAuth(config);
             _db = new KoolbaseDatabase(config, () => _auth?.currentUser?.id ?? null, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
             _storage = new KoolbaseStorage(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
+            _fiscal = new KoolbaseFiscal(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
             _realtime = new KoolbaseRealtime(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), () => _auth?.currentUser?.id ?? null);
             _functions = new KoolbaseFunctions(config, () => _auth?.validAccessToken() ?? Promise.resolve(null), async () => { await _auth?.clearStoredSession(); });
             const deviceId = await getOrCreateDeviceId();
@@ -66,6 +68,7 @@ export const Koolbase = {
     get auth() { ensureInitialized(); return _auth; },
     get db() { ensureInitialized(); return _db; },
     get storage() { ensureInitialized(); return _storage; },
+    get fiscal() { ensureInitialized(); return _fiscal; },
     get realtime() { ensureInitialized(); return _realtime; },
     get functions() { ensureInitialized(); return _functions; },
     get analytics() {

package/package.json

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