@udibo/oauth2 0.38.0 → 0.39.0

package/dist/identity/mfa/service.d.ts

@@ -69,7 +69,9 @@ export interface MfaStore {
     getRecoveryHashes(userId: string): Promise<string[]>;
     /**
      * Replace the user's recovery-code hashes with exactly this set — used for
-     * initial issue, regeneration, and disable (`[]`).
+     * initial issue, regeneration, and disable (`[]`). `MfaService` issues codes
+     * only once the TOTP credential is active, so a store may keep recovery
+     * hashes on the credential's record and drop a write for a user without one.
      */
     setRecoveryHashes(userId: string, hashes: string[]): Promise<void>;
     /**

package/dist/testing/contract/lockout-store.d.ts

@@ -31,6 +31,17 @@ export interface LockoutStoreContractOptions {
      * asserts.
      */
     makeStore(): Promise<LockoutStore> | LockoutStore;
+    /**
+     * The account the cases act on, in your application's id format. A store
+     * that keeps the count on the user's own row needs it to name a user that
+     * exists. Defaults to `"user-1"`.
+     */
+    userId?: string;
+    /**
+     * A second account, distinct from {@link LockoutStoreContractOptions.userId},
+     * whose count must stay apart from the first. Defaults to `"user-2"`.
+     */
+    otherUserId?: string;
     /**
      * Overrides the name passed to the outer `describe` block. Defaults to
      * `"LockoutStore contract"`.

package/dist/testing/contract/lockout-store.js

@@ -23,8 +23,6 @@
  * @module
  */
 import { beforeEach, describe, expect, it } from "vitest";
-const USER = "user-1";
-const OTHER_USER = "user-2";
 /**
  * Runs the {@link LockoutStore} contract suite. Call it from your own test
  * file — it registers `describe` / `it` blocks the test runner picks up.
@@ -33,6 +31,8 @@ const OTHER_USER = "user-2";
  * clock-free and never need a timer.
  */
 export function runLockoutStoreContractTests(options) {
+    const USER = options.userId ?? "user-1";
+    const OTHER_USER = options.otherUserId ?? "user-2";
     describe(options.describeName ?? "LockoutStore contract", () => {
         let store;
         let now;

package/dist/testing/contract/mfa-store.d.ts

@@ -32,6 +32,17 @@ export interface MfaStoreContractOptions {
      * meaningless.
      */
     makeStore(): Promise<MfaStore> | MfaStore;
+    /**
+     * The user the cases act on, in your application's id format. A store whose
+     * rows reference a users table needs it to name a user that exists. Defaults
+     * to `"user-1"`.
+     */
+    userId?: string;
+    /**
+     * A second user, distinct from {@link MfaStoreContractOptions.userId}, whose
+     * records must stay apart from the first. Defaults to `"user-2"`.
+     */
+    otherUserId?: string;
     /**
      * Overrides the name passed to the outer `describe` block. Defaults to
      * `"MfaStore contract"`.

package/dist/testing/contract/mfa-store.js

@@ -25,8 +25,6 @@
  */
 import { beforeEach, describe, expect, it } from "vitest";
 import { CONCURRENT_CALLERS, race } from "./_race.js";
-const USER = "user-1";
-const OTHER_USER = "user-2";
 const SECRET_A = "AAAAAAAAAAAAAAAA";
 const SECRET_B = "BBBBBBBBBBBBBBBB";
 function countTrue(results) {
@@ -43,6 +41,8 @@ function countTrue(results) {
  * probabilistic, so a lucky interleaving can still pass a single run.
  */
 export function runMfaStoreContractTests(options) {
+    const USER = options.userId ?? "user-1";
+    const OTHER_USER = options.otherUserId ?? "user-2";
     describe(options.describeName ?? "MfaStore contract", () => {
         let store;
         beforeEach(async () => {
@@ -165,7 +165,19 @@ export function runMfaStoreContractTests(options) {
                 expect((await store.getTotp(USER))?.lastStep, "the highest accepted step must survive a concurrent lower one").toStrictEqual(105);
             });
         });
+        describe("recovery hashes for a user without a credential", () => {
+            it("reads none and redeems none", async () => {
+                expect(await store.getRecoveryHashes(OTHER_USER)).toStrictEqual([]);
+                expect(await store.consumeRecoveryHash(OTHER_USER, "h1")).toBe(false);
+            });
+        });
         describe("recovery hashes", () => {
+            beforeEach(async () => {
+                for (const user of [USER, OTHER_USER]) {
+                    await store.setPendingTotp(user, SECRET_A);
+                    await store.activateTotp(user, SECRET_A, 1);
+                }
+            });
             it("returns an empty list for a user with none", async () => {
                 expect(await store.getRecoveryHashes(USER)).toStrictEqual([]);
             });

package/dist/testing/contract/otp-store.d.ts

@@ -41,6 +41,9 @@ export interface OtpStoreContractOptions {
  * Runs the {@link OtpStore} contract suite. Call it from your own test file —
  * it registers `describe` / `it` blocks the test runner picks up.
  *
+ * Record ids, known and unknown alike, are UUIDs — the ids `EmailOtpService`
+ * issues — so a store with a `uuid` id column accepts every one.
+ *
  * The concurrency case fires overlapping `recordAttempt` calls and requires
  * each to see a distinct count; a store that reads, awaits, then writes hands
  * the same count to every guess and fails it.

package/dist/testing/contract/otp-store.js

@@ -28,11 +28,10 @@ const EMAIL = "user@example.com";
 const OTHER_EMAIL = "other@example.com";
 const PURPOSE = "signin";
 const OTHER_PURPOSE = "step-up";
-let sequence = 0;
 function record(overrides = {}) {
     const now = Date.now();
     return {
-        id: `otp-${++sequence}`,
+        id: crypto.randomUUID(),
         email: EMAIL,
         purpose: PURPOSE,
         codeHash: "hash",
@@ -47,6 +46,9 @@ function record(overrides = {}) {
  * Runs the {@link OtpStore} contract suite. Call it from your own test file —
  * it registers `describe` / `it` blocks the test runner picks up.
  *
+ * Record ids, known and unknown alike, are UUIDs — the ids `EmailOtpService`
+ * issues — so a store with a `uuid` id column accepts every one.
+ *
  * The concurrency case fires overlapping `recordAttempt` calls and requires
  * each to see a distinct count; a store that reads, awaits, then writes hands
  * the same count to every guess and fails it.
@@ -100,7 +102,7 @@ export function runOtpStoreContractTests(options) {
                 const results = await race(() => store.consume(created.id));
                 expect(results.filter((claimed) => claimed).length, "a code is single-use — consumers racing one code must not each " +
                     "be told they claimed it").toBe(1);
-                expect(await store.consume("missing-code")).toBe(false);
+                expect(await store.consume(crypto.randomUUID())).toBe(false);
             });
             it("takes the record out of the active set", async () => {
                 const created = record();
@@ -120,7 +122,7 @@ export function runOtpStoreContractTests(options) {
             it("is a no-op for an unknown id", async () => {
                 const created = record();
                 await store.create(created);
-                await store.consume("no-such-id");
+                await store.consume(crypto.randomUUID());
                 expect((await store.findActive(EMAIL, PURPOSE))?.id).toBe(created.id);
             });
         });
@@ -138,7 +140,7 @@ export function runOtpStoreContractTests(options) {
             it("is a no-op for an unknown id", async () => {
                 const created = record();
                 await store.create(created);
-                await store.invalidateById("no-such-id");
+                await store.invalidateById(crypto.randomUUID());
                 expect((await store.findActive(EMAIL, PURPOSE))?.id).toBe(created.id);
             });
         });
@@ -171,7 +173,7 @@ export function runOtpStoreContractTests(options) {
                 expect(await store.recordAttempt(created.id)).toBe(3);
             });
             it("returns 0 for an unknown id", async () => {
-                expect(await store.recordAttempt("no-such-id")).toBe(0);
+                expect(await store.recordAttempt(crypto.randomUUID())).toBe(0);
             });
             it("counts each record separately", async () => {
                 const mine = record();

package/dist/testing/contract/token-flow-store.d.ts

@@ -38,6 +38,18 @@ export interface TokenFlowStoreContractOptions {
      * that meant to implement it and does not fails loudly.
      */
     deleteBySubject?: boolean;
+    /**
+     * The subject the cases issue tokens for, in your application's id format. A
+     * store whose rows reference a users table needs it to name a user that
+     * exists. Defaults to `"user-1"`.
+     */
+    subject?: string;
+    /**
+     * A second subject, distinct from
+     * {@link TokenFlowStoreContractOptions.subject}, whose tokens must survive
+     * operations on the first. Defaults to `"user-2"`.
+     */
+    otherSubject?: string;
     /**
      * Overrides the name passed to the outer `describe` block. Defaults to
      * `"TokenFlowStore contract"`.
@@ -48,6 +60,9 @@ export interface TokenFlowStoreContractOptions {
  * Runs the {@link TokenFlowStore} contract suite. Call it from your own test
  * file — it registers `describe` / `it` blocks the test runner picks up.
  *
+ * Token hashes are unique to each test, so a store whose hash column is unique
+ * across tenants or test files never collides with an earlier run's rows.
+ *
  * The concurrency cases redeem one token from eight callers at once. A store
  * that reads, awaits, then writes hands the token to more than one of them and
  * fails in practice — a race is probabilistic, so a lucky interleaving can

package/dist/testing/contract/token-flow-store.js

@@ -25,25 +25,16 @@ import { assert, beforeEach, describe, expect, it } from "vitest";
 import { CONCURRENT_CALLERS, race } from "./_race.js";
 const PURPOSE = "password-reset";
 const OTHER_PURPOSE = "email-verification";
-const SUBJECT = "user-1";
-const OTHER_SUBJECT = "user-2";
 function countTrue(results) {
     return results.filter((result) => result).length;
 }
-function record(overrides) {
-    const now = Date.now();
-    return {
-        purpose: PURPOSE,
-        subject: SUBJECT,
-        expiresAt: now + 60_000,
-        createdAt: now,
-        ...overrides,
-    };
-}
 /**
  * Runs the {@link TokenFlowStore} contract suite. Call it from your own test
  * file — it registers `describe` / `it` blocks the test runner picks up.
  *
+ * Token hashes are unique to each test, so a store whose hash column is unique
+ * across tenants or test files never collides with an earlier run's rows.
+ *
  * The concurrency cases redeem one token from eight callers at once. A store
  * that reads, awaits, then writes hands the token to more than one of them and
  * fails in practice — a race is probabilistic, so a lucky interleaving can
@@ -51,22 +42,39 @@ function record(overrides) {
  */
 export function runTokenFlowStoreContractTests(options) {
     const expectDeleteBySubject = options.deleteBySubject ?? true;
+    const SUBJECT = options.subject ?? "user-1";
+    const OTHER_SUBJECT = options.otherSubject ?? "user-2";
     describe(options.describeName ?? "TokenFlowStore contract", () => {
         let store;
+        let testId;
+        function hash(name) {
+            return `hash-${name}-${testId}`;
+        }
+        function record(overrides) {
+            const now = Date.now();
+            return {
+                purpose: PURPOSE,
+                subject: SUBJECT,
+                expiresAt: now + 60_000,
+                createdAt: now,
+                ...overrides,
+            };
+        }
         beforeEach(async () => {
+            testId = crypto.randomUUID();
             store = await options.makeStore();
         });
         describe("save / get", () => {
             it("returns null for an unknown token hash", async () => {
-                expect(await store.get("no-such-hash")).toBe(null);
+                expect(await store.get(hash("unknown"))).toBe(null);
             });
             it("round-trips every field of a saved record", async () => {
                 const saved = record({
-                    tokenHash: "hash-1",
+                    tokenHash: hash("1"),
                     data: { email: "user@example.com" },
                 });
                 await store.save(saved);
-                const fetched = await store.get("hash-1");
+                const fetched = await store.get(hash("1"));
                 assert(fetched !== null, "a saved record must be readable back");
                 expect(fetched.purpose).toStrictEqual(saved.purpose);
                 expect(fetched.subject).toStrictEqual(saved.subject);
@@ -76,53 +84,53 @@ export function runTokenFlowStoreContractTests(options) {
                 expect(fetched.consumedAt).toBe(undefined);
             });
             it("returns an expired record rather than hiding it", async () => {
-                await store.save(record({ tokenHash: "hash-expired", expiresAt: Date.now() - 1000 }));
-                const fetched = await store.get("hash-expired");
+                await store.save(record({ tokenHash: hash("expired"), expiresAt: Date.now() - 1000 }));
+                const fetched = await store.get(hash("expired"));
                 assert(fetched !== null, "expiry is the service's call — it reports `expired` distinctly " +
                     "from `invalid`, which it cannot do if the store swallows the row");
             });
             it("keeps records with different hashes independent", async () => {
-                await store.save(record({ tokenHash: "hash-1" }));
-                await store.save(record({ tokenHash: "hash-2" }));
-                expect((await store.get("hash-1"))?.tokenHash).toBe("hash-1");
-                expect((await store.get("hash-2"))?.tokenHash).toBe("hash-2");
+                await store.save(record({ tokenHash: hash("1") }));
+                await store.save(record({ tokenHash: hash("2") }));
+                expect((await store.get(hash("1")))?.tokenHash).toBe(hash("1"));
+                expect((await store.get(hash("2")))?.tokenHash).toBe(hash("2"));
             });
         });
         describe("markConsumed", () => {
             it("claims a live record and stamps it", async () => {
-                await store.save(record({ tokenHash: "hash-1" }));
+                await store.save(record({ tokenHash: hash("1") }));
                 const consumedAt = Date.now();
-                expect(await store.markConsumed("hash-1", consumedAt)).toBe(true);
-                expect((await store.get("hash-1"))?.consumedAt).toBe(consumedAt);
+                expect(await store.markConsumed(hash("1"), consumedAt)).toBe(true);
+                expect((await store.get(hash("1")))?.consumedAt).toBe(consumedAt);
             });
             it("refuses a record already consumed, keeping the first stamp", async () => {
-                await store.save(record({ tokenHash: "hash-1" }));
+                await store.save(record({ tokenHash: hash("1") }));
                 const first = Date.now();
-                await store.markConsumed("hash-1", first);
-                expect(await store.markConsumed("hash-1", first + 5_000)).toBe(false);
-                expect((await store.get("hash-1"))?.consumedAt, "a losing claim must not overwrite the winner's record").toBe(first);
+                await store.markConsumed(hash("1"), first);
+                expect(await store.markConsumed(hash("1"), first + 5_000)).toBe(false);
+                expect((await store.get(hash("1")))?.consumedAt, "a losing claim must not overwrite the winner's record").toBe(first);
             });
             it("refuses an unknown token hash", async () => {
-                expect(await store.markConsumed("no-such-hash", Date.now())).toBe(false);
+                expect(await store.markConsumed(hash("unknown"), Date.now())).toBe(false);
             });
             it(`claims a token for exactly one of ${CONCURRENT_CALLERS} concurrent redemptions`, async () => {
-                await store.save(record({ tokenHash: "hash-1" }));
+                await store.save(record({ tokenHash: hash("1") }));
                 const now = Date.now();
-                const results = await race((caller) => store.markConsumed("hash-1", now + caller));
+                const results = await race((caller) => store.markConsumed(hash("1"), now + caller));
                 expect(countTrue(results), "a link is single-use — requests racing one link must not each be " +
                     "told they claimed it").toBe(1);
             });
             it("claims both tokens when two different ones are redeemed concurrently", async () => {
-                await store.save(record({ tokenHash: "hash-1" }));
-                await store.save(record({ tokenHash: "hash-2" }));
+                await store.save(record({ tokenHash: hash("1") }));
+                await store.save(record({ tokenHash: hash("2") }));
                 const now = Date.now();
                 const results = await Promise.all([
-                    store.markConsumed("hash-1", now),
-                    store.markConsumed("hash-2", now),
+                    store.markConsumed(hash("1"), now),
+                    store.markConsumed(hash("2"), now),
                 ]);
                 expect(countTrue(results)).toBe(2);
-                assert((await store.get("hash-1"))?.consumedAt !== undefined &&
-                    (await store.get("hash-2"))?.consumedAt !== undefined, "neither stamp may be lost to the other's stale read");
+                assert((await store.get(hash("1")))?.consumedAt !== undefined &&
+                    (await store.get(hash("2")))?.consumedAt !== undefined, "neither stamp may be lost to the other's stale read");
             });
         });
         if (expectDeleteBySubject) {
@@ -134,33 +142,39 @@ export function runTokenFlowStoreContractTests(options) {
                         "`deleteBySubject: false` to record the gap.");
                 });
                 it("drops the pending tokens for one (purpose, subject)", async () => {
-                    await store.save(record({ tokenHash: "hash-1" }));
-                    await store.save(record({ tokenHash: "hash-2" }));
+                    await store.save(record({ tokenHash: hash("1") }));
+                    await store.save(record({ tokenHash: hash("2") }));
                     await store.deleteBySubject(PURPOSE, SUBJECT);
-                    expect(await store.get("hash-1")).toBe(null);
-                    expect(await store.get("hash-2")).toBe(null);
+                    expect(await store.get(hash("1"))).toBe(null);
+                    expect(await store.get(hash("2"))).toBe(null);
                 });
                 it("leaves other subjects and other purposes alone", async () => {
-                    await store.save(record({ tokenHash: "hash-mine" }));
-                    await store.save(record({ tokenHash: "hash-other-subject", subject: OTHER_SUBJECT }));
-                    await store.save(record({ tokenHash: "hash-other-purpose", purpose: OTHER_PURPOSE }));
+                    await store.save(record({ tokenHash: hash("mine") }));
+                    await store.save(record({
+                        tokenHash: hash("other-subject"),
+                        subject: OTHER_SUBJECT,
+                    }));
+                    await store.save(record({
+                        tokenHash: hash("other-purpose"),
+                        purpose: OTHER_PURPOSE,
+                    }));
                     await store.deleteBySubject(PURPOSE, SUBJECT);
-                    expect(await store.get("hash-mine")).toBe(null);
-                    assert((await store.get("hash-other-subject")) !== null, "another subject's token must survive");
-                    assert((await store.get("hash-other-purpose")) !== null, "the same subject's token for another purpose must survive");
+                    expect(await store.get(hash("mine"))).toBe(null);
+                    assert((await store.get(hash("other-subject"))) !== null, "another subject's token must survive");
+                    assert((await store.get(hash("other-purpose"))) !== null, "the same subject's token for another purpose must survive");
                 });
                 it("is a no-op when the pair has no tokens", async () => {
-                    await store.save(record({ tokenHash: "hash-1" }));
+                    await store.save(record({ tokenHash: hash("1") }));
                     await store.deleteBySubject(PURPOSE, OTHER_SUBJECT);
-                    assert((await store.get("hash-1")) !== null);
+                    assert((await store.get(hash("1"))) !== null);
                 });
                 it("keeps an already-consumed record so it still reads as consumed", async () => {
-                    await store.save(record({ tokenHash: "hash-used" }));
-                    await store.save(record({ tokenHash: "hash-pending" }));
-                    expect(await store.markConsumed("hash-used", Date.now())).toBe(true);
+                    await store.save(record({ tokenHash: hash("used") }));
+                    await store.save(record({ tokenHash: hash("pending") }));
+                    expect(await store.markConsumed(hash("used"), Date.now())).toBe(true);
                     await store.deleteBySubject(PURPOSE, SUBJECT);
-                    expect(await store.get("hash-pending"), "the pending token must be dropped").toBe(null);
-                    const used = await store.get("hash-used");
+                    expect(await store.get(hash("pending")), "the pending token must be dropped").toBe(null);
+                    const used = await store.get(hash("used"));
                     assert(used !== null, "a consumed record must survive so inspect() can answer " +
                         "`consumed` rather than the generic `invalid`");
                     assert(used.consumedAt !== undefined, "the surviving record must still carry its consumedAt stamp");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@udibo/oauth2",
-  "version": "0.38.0",
+  "version": "0.39.0",
   "description": "A flexible OAuth2 toolkit: framework-agnostic authorization & resource servers, a typed client, Hono adapters (including a backend-for-frontend), and React bindings.",
   "keywords": [
     "authorization-server",