@cortexkit/common-auth 0.4.6 → 0.6.0

package/dist/store/index.d.ts

@@ -6,13 +6,14 @@ export { countUnknownIdentityRows, DUPLICATE_IDENTITY_REASON, } from './identity
 export type { HoldPoint, InitializeOutcome, WriteStep } from './mutate.js';
 export type { OpenPoolStoreOptions, PoolLoad, PoolStore, } from './pool.js';
 export { openPoolStore } from './pool.js';
+export type { ProviderStateMutator, UpdateProviderStateResult, } from './provider-state.js';
 export type { PullHook, PullRequest } from './pull.js';
 export type { ProviderRefresh, ProviderRefreshResult, RefreshOptions, RefreshOutcome, } from './refresh.js';
 export type { LockEvent, PoolLockOptions, PoolLockSpec, } from './refresh-lock.js';
 export { POOL_LOCK_DEFAULTS } from './refresh-lock.js';
-export type { AddInput, AddResult, FailureHook, RemoveOptions, RemoveResult, RemoveView, ReorderOptions, ReorderResult, RowOperationOptions, RowToggleOptions, } from './rows.js';
+export type { AddInput, AddResult, CredentialWriteInput, FailureHook, RemoveOptions, RemoveResult, RemoveView, ReorderOptions, ReorderResult, RowOperationOptions, RowToggleOptions, } from './rows.js';
 export type { PullReason } from './runtime.js';
-export type { ApiKeyCredential, CredentialStampStatus, OAuthCredential, PoolCredential, PoolRow, QuotaCodec, RotateCredential, StoredCredential, } from './schema.js';
-export { fingerprintOf, LEGACY_STORE_VERSION, POOL_KEY, POOL_ROWS_KEY, POOL_SCHEMA_VERSION, REFRESH_STAMP_TOLERANCE_MS, rowLockKey, } from './schema.js';
+export type { ApiKeyCredential, CredentialStampStatus, OAuthCredential, PoolCredential, PoolRow, ProviderStateCodec, ProviderStateDrop, ProviderStateReplacement, QuotaCodec, RotateCredential, StoredCredential, } from './schema.js';
+export { fingerprintOf, LEGACY_STORE_VERSION, POOL_KEY, POOL_ROWS_KEY, POOL_SCHEMA_VERSION, PROVIDER_STATE_KEY, REFRESH_STAMP_TOLERANCE_MS, rowLockKey, } from './schema.js';
 export type { PoolSettings, SettingsMutator, SettingsRead, UpdateSettingsOptions, UpdateSettingsResult, } from './settings.js';
 export { POOL_OWNED_KEYS } from './settings.js';

package/dist/store/index.js

@@ -2,5 +2,5 @@ export { PoolOperationError, PoolReentryError } from './errors.js';
 export { countUnknownIdentityRows, DUPLICATE_IDENTITY_REASON, } from './identity.js';
 export { openPoolStore } from './pool.js';
 export { POOL_LOCK_DEFAULTS } from './refresh-lock.js';
-export { fingerprintOf, LEGACY_STORE_VERSION, POOL_KEY, POOL_ROWS_KEY, POOL_SCHEMA_VERSION, REFRESH_STAMP_TOLERANCE_MS, rowLockKey, } from './schema.js';
+export { fingerprintOf, LEGACY_STORE_VERSION, POOL_KEY, POOL_ROWS_KEY, POOL_SCHEMA_VERSION, PROVIDER_STATE_KEY, REFRESH_STAMP_TOLERANCE_MS, rowLockKey, } from './schema.js';
 export { POOL_OWNED_KEYS } from './settings.js';

package/dist/store/mutate.d.ts

@@ -1,7 +1,7 @@
 import { type PoolFailurePhase, type PoolOperation, PoolOperationError } from './errors.js';
 import { type PoolLogger } from './hooks.js';
 import { type LockEnvironment, LockStack, type PoolLockOptions, type PoolLockSpec } from './refresh-lock.js';
-import { type PoolRow, type QuotaCodec, type StoredCredential } from './schema.js';
+import { type PoolRow, type ProviderStateCodec, type QuotaCodec, type StoredCredential } from './schema.js';
 /** Named points on the write path, for crash and ownership injection. */
 export type WriteStep = 'before-config-write' | 'after-config-write' | 'before-state-write' | 'after-state-write';
 /** Awaitable pause points on the pull and refresh paths. */
@@ -11,6 +11,8 @@ export interface StoreContext {
     configPath: string;
     statePath: string;
     codec: QuotaCodec;
+    /** The provider-state codec; without one no row shows a provider state. */
+    providerState?: ProviderStateCodec;
     now: () => number;
     storeLocks: readonly PoolLockSpec[];
     lockDefaults: PoolLockOptions;

package/dist/store/mutate.js

@@ -41,6 +41,7 @@ export async function readPool(ctx) {
         state: state.state,
         rows: loadRows(config.config, state.state, ctx.codec, {
             requireCredentialStamps: ctx.requireCredentialStamps === true,
+            ...(ctx.providerState ? { providerState: ctx.providerState } : {}),
         }),
     };
 }
@@ -90,6 +91,9 @@ export class Transaction {
     rows() {
         return loadRows(this.config, this.state, this.ctx.codec, {
             requireCredentialStamps: this.ctx.requireCredentialStamps === true,
+            ...(this.ctx.providerState
+                ? { providerState: this.ctx.providerState }
+                : {}),
         });
     }
     row(id) {

package/dist/store/pool.d.ts

@@ -2,11 +2,12 @@ import { type Attribution } from './attribution.js';
 import type { PoolOperationError } from './errors.js';
 import type { PoolLogger } from './hooks.js';
 import { type HoldPoint, type InitializeOutcome, type StoreContext } from './mutate.js';
+import { type ProviderStateMutator, type UpdateProviderStateResult } from './provider-state.js';
 import { type PullHook } from './pull.js';
 import { type ProviderRefresh, type RefreshOptions, type RefreshOutcome } from './refresh.js';
 import { type LockEnvironment, type PoolLockOptions, type PoolLockSpec } from './refresh-lock.js';
-import { type AddInput, type AddResult, type RemoveOptions, type RemoveResult, type ReorderOptions, type ReorderResult, type RowOperationOptions, type RowToggleOptions } from './rows.js';
-import { type PoolCredential, type PoolRow, type QuotaCodec, type RotateCredential, type StoredCredential } from './schema.js';
+import { type AddInput, type AddResult, type CredentialWriteInput, type RemoveOptions, type RemoveResult, type ReorderOptions, type ReorderResult, type RowOperationOptions, type RowToggleOptions } from './rows.js';
+import { type PoolCredential, type PoolRow, type ProviderStateCodec, type QuotaCodec, type RotateCredential, type StoredCredential } from './schema.js';
 import { type SettingsMutator, type SettingsRead, type UpdateSettingsOptions, type UpdateSettingsResult } from './settings.js';
 export interface OpenPoolStoreOptions {
     /** The provider every row of this pool belongs to; keys the provider-wide lock. */
@@ -14,6 +15,13 @@ export interface OpenPoolStoreOptions {
     configPath: string;
     statePath: string;
     quota: QuotaCodec;
+    /**
+     * The codec of the provider state kept beside each row's credential (see
+     * `ProviderStateCodec`). Without it no row shows a provider state, and
+     * every write that would set one refuses (`invalid-input`); writes that
+     * leave it alone keep the value on disk as it is, and `replace` clears it.
+     */
+    providerState?: ProviderStateCodec;
     /**
      * Refuse every credential this store did not stamp (default false, which
      * loads unstamped and mis-stamped credentials as older writers left them).
@@ -81,9 +89,12 @@ export interface PoolStore {
         status: InitializeOutcome;
     }>;
     add(input: AddInput, options?: RowOperationOptions): Promise<AddResult>;
-    replace(id: string, credential: PoolCredential, input?: {
-        identity?: string;
-    }, options?: RowOperationOptions): Promise<{
+    /**
+     * Gives a row a new credential and a new credential epoch. Since 0.6.0 the
+     * row's provider state is whatever `ProviderStateCodec.onReplace` returns;
+     * without that hook it is `input.providerState`, else cleared.
+     */
+    replace(id: string, credential: PoolCredential, input?: CredentialWriteInput, options?: RowOperationOptions): Promise<{
         id: string;
         credential: StoredCredential;
         credentialEpoch: number;
@@ -94,12 +105,17 @@ export interface PoolStore {
      * to keep the row's, and one that gives another is refused
      * (`endpoint-mismatch`) before writing: that is a `replace`.
      */
-    rotate(id: string, credential: RotateCredential, input?: {
-        identity?: string;
-    }, options?: RowOperationOptions): Promise<{
+    rotate(id: string, credential: RotateCredential, input?: CredentialWriteInput, options?: RowOperationOptions): Promise<{
         id: string;
         credential: StoredCredential;
     }>;
+    /**
+     * Changes a row's provider state without touching its credential (since
+     * 0.6.0), under the row lock, `extraLocks` and the store locks. Refuses
+     * (`attribution`) once the row has moved off the credential epoch or
+     * identity in `fence`, and (`unknown-row`) once it is removed.
+     */
+    updateProviderState(id: string, fence: Attribution, mutator: ProviderStateMutator, options?: RowToggleOptions): Promise<UpdateProviderStateResult>;
     /**
      * Sets `enabled: false` and the entry's `disabledReason`. Takes the row
      * lock, then `extraLocks`, then the store locks (the row lock and

package/dist/store/pool.js

@@ -1,5 +1,6 @@
 import { recordQuota } from './attribution.js';
 import { initializePool, readPool, } from './mutate.js';
+import { updateProviderStateRow, } from './provider-state.js';
 import { PullScheduler } from './pull.js';
 import { refreshRow, } from './refresh.js';
 import { POOL_LOCK_DEFAULTS, } from './refresh-lock.js';
@@ -47,6 +48,7 @@ export function openPoolStore(options) {
         configPath: options.configPath,
         statePath: options.statePath,
         codec: options.quota,
+        ...(options.providerState ? { providerState: options.providerState } : {}),
         now: options.now ?? Date.now,
         storeLocks: options.storeLocks ?? [
             { name: 'save', path: options.configPath },
@@ -98,6 +100,7 @@ export function openPoolStore(options) {
         add: (input, callOptions) => addRow(rt, input, callOptions),
         replace: (id, credential, input, callOptions) => replaceRow(rt, id, credential, input, callOptions),
         rotate: (id, credential, input, callOptions) => rotateRow(rt, id, credential, input, callOptions),
+        updateProviderState: (id, fence, mutator, callOptions) => updateProviderStateRow(rt, id, fence, mutator, callOptions),
         disable: (id, reason, callOptions) => disableRow(rt, id, reason, callOptions),
         enable: (id, callOptions) => enableRow(rt, id, callOptions),
         remove: (id, callOptions) => removeRow(rt, id, callOptions),

package/dist/store/provider-state.d.ts

@@ -0,0 +1,86 @@
+import type { Attribution } from './attribution.js';
+import type { PoolOperation } from './errors.js';
+import type { RowToggleOptions } from './rows.js';
+import { type StoreRuntime } from './runtime.js';
+import { type PoolRow, type ProviderStateCodec } from './schema.js';
+/**
+ * What a credential write does to the provider state beside it: `keep`
+ * leaves the value on disk as it is (bound by the new stamp only if the old
+ * stamp bound it to the same row, epoch and identity), `set` stores a value
+ * the codec accepted, and `clear` deletes it.
+ */
+export type ProviderStateWrite = {
+    kind: 'keep';
+} | {
+    kind: 'set';
+    value: unknown;
+} | {
+    kind: 'clear';
+};
+/**
+ * A provider state as the store will store it: a JSON round trip of it (so
+ * its digest is the same once read back from disk), accepted by the codec.
+ * Refused before anything is written when the store has no codec, the value
+ * is not JSON, or the codec rejects it.
+ */
+export declare function acceptProviderState(codec: ProviderStateCodec | undefined, operation: PoolOperation, id: string, value: unknown, what?: string): unknown;
+/**
+ * The write for a value a credential write brings (`add` of a secret the
+ * pool holds, `rotate`, a refresh): merged with the row's value on disk by
+ * the codec's `merge` when both exist, else the incoming value as is.
+ */
+export declare function mergedProviderState(codec: ProviderStateCodec | undefined, operation: PoolOperation, id: string, onDisk: unknown, incoming: unknown): ProviderStateWrite;
+/**
+ * The provider state a replace leaves on the row, decided before anything is
+ * written: whatever the codec's `onReplace` returns (undefined clears it), or
+ * without that hook the value handed to `replace`, else nothing. The old
+ * credential's value is never kept by default: it describes the account the
+ * replaced credential belonged to.
+ */
+export declare function replacementProviderState(codec: ProviderStateCodec | undefined, row: PoolRow, credentialEpoch: number, identity: string | undefined, incoming: unknown): ProviderStateWrite;
+/**
+ * The provider-state digest the stamp of a credential write carries, and the
+ * state-file fields it changes. `set` binds the new value; `keep` carries the
+ * old stamp's digest forward only when that stamp bound it to this row as it
+ * stood before the write (same credential lineage, the epoch being written,
+ * the identity recorded before the write); `clear` binds nothing.
+ */
+export declare function providerStateCoverage(codec: ProviderStateCodec | undefined, write: ProviderStateWrite, prior: Record<string, unknown> | undefined, priorRow: PoolRow | undefined, credentialEpoch: number): string | undefined;
+/**
+ * Receives a private copy of the row's provider state (undefined when the row
+ * shows none) and the row as loaded under the locks, and returns the next
+ * provider state; returning undefined clears it, so a mutator that means to
+ * keep the value returns it. It runs under the row lock and the store locks,
+ * so it must not call back into the store (`PoolReentryError`).
+ */
+export type ProviderStateMutator = (current: unknown | undefined, row: PoolRow) => unknown | Promise<unknown>;
+export type UpdateProviderStateResult = {
+    id: string;
+    /** The provider state now on disk; absent when the row has none. */
+    providerState?: unknown;
+    /**
+     * `unchanged`: the mutator returned what the row already shows (or cleared
+     * a row that holds none); nothing was written.
+     */
+    outcome: 'updated' | 'cleared' | 'unchanged';
+};
+/**
+ * Changes a row's provider state without touching its credential, in one
+ * state-file write under the row lock, the caller's extra locks and the
+ * store locks. `fence` is what the caller read the row at: the write is
+ * refused (`attribution`, retryable) when the row has since moved to another
+ * credential epoch or recorded identity, and (`unknown-row`) once it is
+ * removed, so a writer that read the row before a replace or a removal never
+ * lands its value on the new credential or brings a removed row's state back.
+ *
+ * The value is bound by the stamp already beside the credential. When its
+ * credential-bound part is unchanged the stamp is left byte for byte as it
+ * is; otherwise only the stamp's provider-state digest changes, so the
+ * credential's stamp status never moves. With `requireCredentialStamps`, an
+ * unbound row refuses (`unbound-credential`) as every other strict path
+ * does. Without it, a row whose stamp was not written by this store with this
+ * credential at the row's epoch and identity refuses the same way: no stamp
+ * could bind the value, so no reader would ever show it. A `rotate` or
+ * `replace` stamps such a row.
+ */
+export declare function updateProviderStateRow(rt: StoreRuntime, id: string, fence: Attribution, mutator: ProviderStateMutator, options?: RowToggleOptions): Promise<UpdateProviderStateResult>;

package/dist/store/provider-state.js

@@ -0,0 +1,186 @@
+import { assertNotInsideHook, runInsideHook } from './hooks.js';
+import { runOperation, withTransaction } from './mutate.js';
+import { readRow, refusal, requireBound, rowLockSpec, unknownRow, } from './runtime.js';
+import { boundProviderStateDigest, CREDENTIAL_STAMP_KEY, credentialDigest, isCredentialEpoch, isRecord, PROVIDER_STATE_KEY, parseStamp, providerStateDigest, rowLockKey, } from './schema.js';
+/**
+ * A provider state as the store will store it: a JSON round trip of it (so
+ * its digest is the same once read back from disk), accepted by the codec.
+ * Refused before anything is written when the store has no codec, the value
+ * is not JSON, or the codec rejects it.
+ */
+export function acceptProviderState(codec, operation, id, value, what = 'the provider state') {
+    if (!codec)
+        throw refusal(operation, id, 'invalid-input', 'the store was opened without a provider-state codec');
+    let normalized;
+    try {
+        const text = JSON.stringify(value);
+        normalized = text === undefined ? undefined : JSON.parse(text);
+    }
+    catch {
+        normalized = undefined;
+    }
+    if (normalized === undefined)
+        throw refusal(operation, id, 'invalid-provider-state', `${what} cannot be stored as JSON`);
+    if (!codec.validate(normalized))
+        throw refusal(operation, id, 'invalid-provider-state', `the provider-state codec rejected ${what}`);
+    return normalized;
+}
+/**
+ * The write for a value a credential write brings (`add` of a secret the
+ * pool holds, `rotate`, a refresh): merged with the row's value on disk by
+ * the codec's `merge` when both exist, else the incoming value as is.
+ */
+export function mergedProviderState(codec, operation, id, onDisk, incoming) {
+    if (onDisk === undefined || !codec?.merge)
+        return { kind: 'set', value: incoming };
+    return {
+        kind: 'set',
+        value: acceptProviderState(codec, operation, id, codec.merge(structuredClone(onDisk), structuredClone(incoming)), 'the merged provider state'),
+    };
+}
+/**
+ * The provider state a replace leaves on the row, decided before anything is
+ * written: whatever the codec's `onReplace` returns (undefined clears it), or
+ * without that hook the value handed to `replace`, else nothing. The old
+ * credential's value is never kept by default: it describes the account the
+ * replaced credential belonged to.
+ */
+export function replacementProviderState(codec, row, credentialEpoch, identity, incoming) {
+    const hook = codec?.onReplace;
+    const next = hook
+        ? hook(row.providerState === undefined
+            ? undefined
+            : structuredClone(row.providerState), {
+            id: row.id,
+            credentialEpoch,
+            ...(identity !== undefined ? { identity } : {}),
+            ...(incoming !== undefined
+                ? { incoming: structuredClone(incoming) }
+                : {}),
+        })
+        : incoming;
+    if (next === undefined)
+        return { kind: 'clear' };
+    if (!hook)
+        return { kind: 'set', value: next };
+    return {
+        kind: 'set',
+        value: acceptProviderState(codec, 'replace', row.id, next, 'the provider state onReplace returned'),
+    };
+}
+/**
+ * The provider-state digest the stamp of a credential write carries, and the
+ * state-file fields it changes. `set` binds the new value; `keep` carries the
+ * old stamp's digest forward only when that stamp bound it to this row as it
+ * stood before the write (same credential lineage, the epoch being written,
+ * the identity recorded before the write); `clear` binds nothing.
+ */
+export function providerStateCoverage(codec, write, prior, priorRow, credentialEpoch) {
+    if (write.kind === 'set')
+        return providerStateDigest(codec, write.value);
+    if (write.kind === 'clear')
+        return undefined;
+    return boundProviderStateDigest(prior, priorRow?.credential, credentialEpoch, priorRow?.identity);
+}
+/**
+ * Changes a row's provider state without touching its credential, in one
+ * state-file write under the row lock, the caller's extra locks and the
+ * store locks. `fence` is what the caller read the row at: the write is
+ * refused (`attribution`, retryable) when the row has since moved to another
+ * credential epoch or recorded identity, and (`unknown-row`) once it is
+ * removed, so a writer that read the row before a replace or a removal never
+ * lands its value on the new credential or brings a removed row's state back.
+ *
+ * The value is bound by the stamp already beside the credential. When its
+ * credential-bound part is unchanged the stamp is left byte for byte as it
+ * is; otherwise only the stamp's provider-state digest changes, so the
+ * credential's stamp status never moves. With `requireCredentialStamps`, an
+ * unbound row refuses (`unbound-credential`) as every other strict path
+ * does. Without it, a row whose stamp was not written by this store with this
+ * credential at the row's epoch and identity refuses the same way: no stamp
+ * could bind the value, so no reader would ever show it. A `rotate` or
+ * `replace` stamps such a row.
+ */
+export async function updateProviderStateRow(rt, id, fence, mutator, options = {}) {
+    assertNotInsideHook('updateProviderState');
+    const { ctx } = rt;
+    const operation = 'updateProviderState';
+    return runOperation(ctx, operation, id, options.onFailure, async (locks, progress) => {
+        const codec = ctx.providerState;
+        if (!codec)
+            throw refusal(operation, id, 'invalid-input', 'the store was opened without a provider-state codec');
+        if (typeof mutator !== 'function')
+            throw refusal(operation, id, 'invalid-input', 'a mutator is required');
+        const captured = isRecord(fence) ? fence.credentialEpoch : undefined;
+        if (!isCredentialEpoch(captured))
+            throw refusal(operation, id, 'invalid-input', 'the credential epoch the provider state was read at is required');
+        const { row: seen } = await readRow(rt, operation, id);
+        await locks.acquire(rowLockSpec(rt, seen));
+        for (const extra of options.extraLocks ?? [])
+            await locks.acquire(extra);
+        return withTransaction(ctx, locks, progress, { operation, rowId: id }, async (tx) => {
+            const row = tx.row(id);
+            if (!row)
+                throw unknownRow(operation, id);
+            if (rowLockKey(row) !== rowLockKey(seen))
+                throw refusal(operation, id, 'row-key-changed', `row ${id}'s wire identity changed while its lock was being taken`, true);
+            if (row.invalid)
+                throw refusal(operation, id, 'invalid-row', `row ${id} failed validation`);
+            if (!row.credential)
+                throw refusal(operation, id, 'no-credential', `row ${id} holds no credential`);
+            requireBound(operation, row);
+            const epoch = row.credentialEpoch ?? 1;
+            if (epoch !== captured || row.identity !== fence.identity)
+                throw refusal(operation, id, 'attribution', `the provider state for ${id} was read for a credential or account the row no longer holds`, true);
+            const account = tx.stateAccount(id);
+            const rawStamp = account?.[CREDENTIAL_STAMP_KEY];
+            const stamp = parseStamp(rawStamp);
+            if (!isRecord(rawStamp) ||
+                !stamp?.binding ||
+                stamp.digest !== credentialDigest(row.credential) ||
+                stamp.credentialEpoch !== epoch ||
+                stamp.binding.identity !== row.identity)
+                throw refusal(operation, id, 'unbound-credential', `row ${id}'s credential carries no stamp of this store to bind a provider state to (stamp ${row.stamp}); rotate or replace it first`);
+            const current = row.providerState === undefined
+                ? undefined
+                : structuredClone(row.providerState);
+            const returned = await runInsideHook(operation, () => mutator(current, row));
+            const next = returned === undefined
+                ? undefined
+                : acceptProviderState(codec, operation, id, returned, 'the provider state the mutator returned');
+            const held = account !== undefined && Object.hasOwn(account, PROVIDER_STATE_KEY);
+            if (next === undefined
+                ? !held
+                : row.providerState !== undefined &&
+                    JSON.stringify(row.providerState) === JSON.stringify(next))
+                return {
+                    id,
+                    outcome: 'unchanged',
+                    ...(next !== undefined ? { providerState: next } : {}),
+                };
+            const nextAccount = { ...account };
+            if (next === undefined) {
+                delete nextAccount[PROVIDER_STATE_KEY];
+                const nextStamp = { ...rawStamp };
+                delete nextStamp.providerState;
+                nextAccount[CREDENTIAL_STAMP_KEY] = nextStamp;
+            }
+            else {
+                nextAccount[PROVIDER_STATE_KEY] = next;
+                const digest = providerStateDigest(codec, next);
+                // A change confined to the part the codec does not bind to the
+                // credential leaves the stamp exactly as it was.
+                if (stamp.providerState !== digest)
+                    nextAccount[CREDENTIAL_STAMP_KEY] = {
+                        ...rawStamp,
+                        providerState: digest,
+                    };
+            }
+            tx.setStateAccount(id, nextAccount);
+            await tx.commitState();
+            return next === undefined
+                ? { id, outcome: 'cleared' }
+                : { id, outcome: 'updated', providerState: next };
+        });
+    });
+}

package/dist/store/refresh.d.ts

@@ -10,6 +10,14 @@ export interface ProviderRefreshResult {
     expiresIn?: number;
     /** The account's wire identity, when the provider reports one. */
     identity?: string;
+    /**
+     * Provider state that changes with the new token (needs the store's
+     * provider-state codec). It is merged with the row's value on disk
+     * (`ProviderStateCodec.merge`) and written in the same state write as the
+     * rotated credential, under the same commit fence. Left out, the row keeps
+     * its value.
+     */
+    providerState?: unknown;
 }
 export type ProviderRefresh = (credential: OAuthCredential & {
     lastRefreshedAt?: number;

package/dist/store/refresh.js

@@ -2,6 +2,7 @@ import { PoolOperationError } from './errors.js';
 import { assertNotInsideHook, runInsideHook } from './hooks.js';
 import { recordIdentityIn } from './identity.js';
 import { runOperation, withTransaction } from './mutate.js';
+import { acceptProviderState, mergedProviderState } from './provider-state.js';
 import { rotateIn } from './rows.js';
 import { readRow, refusal, requireBound, rowLockSpec, } from './runtime.js';
 import { rotationStamp, rotationStampUntrusted, rowLockKey, } from './schema.js';
@@ -98,6 +99,9 @@ export async function refreshRow(rt, id, provider, options = {}) {
         }
         if (typeof result?.refresh !== 'string' || !result.refresh.trim())
             throw refusal('refresh', id, 'provider', 'the provider returned no refresh token', true);
+        const incoming = result.providerState === undefined
+            ? undefined
+            : acceptProviderState(ctx.providerState, 'refresh', id, result.providerState, 'the provider state the provider returned');
         const commit = await withTransaction(ctx, locks, progress, { operation: 'refresh', rowId: id }, async (tx) => {
             const current = tx.row(id);
             const entry = tx.entry(id);
@@ -142,6 +146,11 @@ export async function refreshRow(rt, id, provider, options = {}) {
             const stored = await rotateIn(rt, tx, id, credential, {
                 stamp: rotationStamp(prior, now),
                 identity: learnt,
+                ...(incoming !== undefined
+                    ? {
+                        providerState: mergedProviderState(ctx.providerState, 'refresh', id, current.providerState, incoming),
+                    }
+                    : {}),
             });
             let identity = current.identity;
             if (learnt !== undefined) {

package/dist/store/rows.d.ts

@@ -1,6 +1,7 @@
 import type { Attribution } from './attribution.js';
 import { PoolOperationError } from './errors.js';
 import { type Transaction } from './mutate.js';
+import { type ProviderStateWrite } from './provider-state.js';
 import type { PoolLockSpec } from './refresh-lock.js';
 import { type StoreRuntime } from './runtime.js';
 import { type CredentialBinding, type PoolCredential, type PoolRow, type RotateCredential, type StoredCredential } from './schema.js';
@@ -80,6 +81,24 @@ export interface AddInput {
     credential: PoolCredential;
     identity?: string;
     label?: string;
+    /**
+     * Provider state for the credential, written in the same state write as
+     * the credential (needs the store's provider-state codec). On an `add`
+     * that rotates a row already holding this secret it is merged with the
+     * row's value (`ProviderStateCodec.merge`); left out, that row keeps its
+     * value.
+     */
+    providerState?: unknown;
+}
+/** What `replace` and `rotate` take beside the credential. */
+export interface CredentialWriteInput {
+    identity?: string;
+    /**
+     * Provider state written in the same state write as the credential. For
+     * `rotate` it is merged with the row's value; left out, the row keeps its
+     * value. For `replace` see `ProviderStateCodec.onReplace`.
+     */
+    providerState?: unknown;
 }
 export type AddResult = {
     /** The row holding the credential; an existing row's id on a re-add. */
@@ -102,18 +121,15 @@ export declare function rotateIn(rt: StoreRuntime, tx: Transaction, id: string,
     clearErrors?: boolean;
     binding?: CredentialBinding;
     identity?: string;
+    providerState?: ProviderStateWrite;
 }): Promise<StoredCredential>;
 export declare function addRow(rt: StoreRuntime, input: AddInput, options?: RowOperationOptions): Promise<AddResult>;
-export declare function replaceRow(rt: StoreRuntime, id: string, credential: PoolCredential, input?: {
-    identity?: string;
-}, options?: RowOperationOptions): Promise<{
+export declare function replaceRow(rt: StoreRuntime, id: string, credential: PoolCredential, input?: CredentialWriteInput, options?: RowOperationOptions): Promise<{
     id: string;
     credential: StoredCredential;
     credentialEpoch: number;
 }>;
-export declare function rotateRow(rt: StoreRuntime, id: string, credential: RotateCredential, input?: {
-    identity?: string;
-}, options?: RowOperationOptions): Promise<{
+export declare function rotateRow(rt: StoreRuntime, id: string, credential: RotateCredential, input?: CredentialWriteInput, options?: RowOperationOptions): Promise<{
     id: string;
     credential: StoredCredential;
 }>;