Interface: MincaAuth

Defined in: packages/core/src/session/auth.ts:408

PropertiesCopy Anchor Link

MethodsCopy Anchor Link

acceptPairing()Copy Anchor Link

acceptPairing(): Promise<void>;

Defined in: packages/core/src/session/auth.ts:457

Meets the computer the pairing link names. Signed in to another account, it stops once the account arrives and sets pairingArrival: answer with answerPairing.

ReturnsCopy Anchor Link

Promise<void>

addPasskey()Copy Anchor Link

addPasskey(): Promise<boolean>;

Defined in: packages/core/src/session/auth.ts:466

Adds a passkey for this site. During setup, moves the flow on; otherwise needs confirm first.

ReturnsCopy Anchor Link

Promise<boolean>

answerPairing()Copy Anchor Link

answerPairing(take): Promise<void>;

Defined in: packages/core/src/session/auth.ts:459

Takes the account a pairing brought (added, or switched to if already here), or lets it go

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

cancelPod()Copy Anchor Link

cancelPod(): void;

Defined in: packages/core/src/session/auth.ts:471

ReturnsCopy Anchor Link

void

choosePod()Copy Anchor Link

choosePod(): Promise<void>;

Defined in: packages/core/src/session/auth.ts:419

Opens a pod. Needs a click. Signed in, it asks what should happen to the data first (podChoice).

ReturnsCopy Anchor Link

Promise<void>

clearError()Copy Anchor Link

clearError(): void;

Defined in: packages/core/src/session/auth.ts:461

ReturnsCopy Anchor Link

void

codeSaved()Copy Anchor Link

codeSaved(): void;

Defined in: packages/core/src/session/auth.ts:447

The recovery code has been kept somewhere safe; on to choosing a way in

ReturnsCopy Anchor Link

void

confirm()Copy Anchor Link

confirm(proof): Promise<boolean>;

Defined in: packages/core/src/session/auth.ts:490

Asks the person to prove it is them, with the account's password, a passkey on this device or the recovery code, even though they are signed in: a page left open, or a sign-in kept for days, is no proof anyone is there. For a few minutes after, the recovery code can be read and the account offered to a phone. A wrong answer sets error.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

confirmPod()Copy Anchor Link

confirmPod(how): Promise<void>;

Defined in: packages/core/src/session/auth.ts:470

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

connectedElsewhere()Copy Anchor Link

connectedElsewhere(origin): readonly object[];

Defined in: packages/core/src/session/auth.ts:533

Other accounts in this place that a carrier at origin is connected to from this home. One browser extension carries one account, so connecting it here moves it off theirs — worth saying before it happens.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

readonly object[]

connections()Copy Anchor Link

connections(): readonly Connection[];

Defined in: packages/core/src/session/auth.ts:527

Apps this account is connected to from this home, newest first

ReturnsCopy Anchor Link

readonly Connection[]

createAccount()Copy Anchor Link

createAccount(name, options?): Promise<void>;

Defined in: packages/core/src/session/auth.ts:445

Makes an account. With username, it is claimed for the account in the background while the rest of setup goes on, and username in the state says how that went.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

disconnect()Copy Anchor Link

disconnect(origin, options?): Promise<boolean>;

Defined in: packages/core/src/session/auth.ts:552

Disconnects an app: revokes its note in every space it could write in — and, for a whole-account app, in the account registry — so nothing it writes from now on counts, and forgets it. What this home had seen it write stays. What it could already read, it keeps — reading is holding a space's key, and that is not taken back.

Disconnecting by origin disconnects every connection made from it but a carrier, which goes only by { audience }, its own key. Programs connected by code are at the home's own origin; { audience } disconnects one.

The app hears of it when the revokes reach it: from this node, or a device that has them. { waitMs } waits up to that long for a peer to take them in, and the answer says whether one did. False means they are still only here: the app keeps working until this home is next online with another of the account's devices or apps.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

dismissMoved()Copy Anchor Link

dismissMoved(): void;

Defined in: packages/core/src/session/auth.ts:482

ReturnsCopy Anchor Link

void

dismissPairing()Copy Anchor Link

dismissPairing(): void;

Defined in: packages/core/src/session/auth.ts:460

ReturnsCopy Anchor Link

void

finishSetup()Copy Anchor Link

finishSetup(): void;

Defined in: packages/core/src/session/auth.ts:449

Leaves the optional pod step with the data in this browser

ReturnsCopy Anchor Link

void

forgetBrowserCopy()Copy Anchor Link

forgetBrowserCopy(): Promise<void>;

Defined in: packages/core/src/session/auth.ts:473

Removes the copy this browser kept after a move into a pod

ReturnsCopy Anchor Link

Promise<void>

getState()Copy Anchor Link

getState(): AuthState;

Defined in: packages/core/src/session/auth.ts:409

ReturnsCopy Anchor Link

AuthState

grant()Copy Anchor Link

grant(choice): Promise<Omit<Grant, "home">>;

Defined in: packages/core/src/session/auth.ts:509

Gives an app access, as the account home: makes any spaces it asked for, signs a note from the account to the app's key for these spaces, and remembers the app as connected. The seed signs here and goes nowhere.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<Omit<Grant, "home">>

grantCarry()Copy Anchor Link

grantCarry(choice): Promise<Omit<CarryGrant, "home">>;

Defined in: packages/core/src/session/auth.ts:515

Starts using a carrier, as the account home: makes its carry space, fills it with a pass for every space, and remembers it as connected. The carrier gets no key that reads or writes a space.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<Omit<CarryGrant, "home">>

isConfirmed()Copy Anchor Link

isConfirmed(): boolean;

Defined in: packages/core/src/session/auth.ts:494

Whether confirm succeeded in the last few minutes

ReturnsCopy Anchor Link

boolean

mayGrant()Copy Anchor Link

mayGrant(): boolean;

Defined in: packages/core/src/session/auth.ts:499

Whether grant and grantCarry may run now: isConfirmed, or a sign-in with a password, passkey or the recovery code in the last few minutes.

ReturnsCopy Anchor Link

boolean

offerToPhone()Copy Anchor Link

offerToPhone(onStage): Promise<PairingOffer>;

Defined in: packages/core/src/session/auth.ts:503

Starts offering this account to a phone

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<PairingOffer>

propose()Copy Anchor Link

propose(choice): Promise<Proposed>;

Defined in: packages/core/src/session/auth.ts:525

Adds the subscriptions an app connected from this home proposed, as the account home — the ones the person kept, naming it, looking only at spaces it may reach.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<Proposed>

ThrowsCopy Anchor Link

When no app from origin is connected here (a carrier or a program connected by code doesn't count), or a proposal names a space it wasn't given

recoveryCode()Copy Anchor Link

recoveryCode(): string | null;

Defined in: packages/core/src/session/auth.ts:501

The recovery code of the open account, for a few minutes after confirm. Null otherwise.

ReturnsCopy Anchor Link

string | null

removeAccount()Copy Anchor Link

removeAccount(): Promise<boolean>;

Defined in: packages/core/src/session/auth.ts:481

Removes the open account from this browser, after confirm and once no app is connected from here: signs out, then deletes the account and its spaces' data from this browser, as clearing its site data would. Copies elsewhere, on other devices, carriers or hosts, stay; without one, its private spaces are gone. Not for an account kept in a folder: that folder is its copy.

ReturnsCopy Anchor Link

Promise<boolean>

removeShortcut()Copy Anchor Link

removeShortcut(kind): Promise<boolean>;

Defined in: packages/core/src/session/auth.ts:469

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

rename()Copy Anchor Link

rename(name): Promise<boolean>;

Defined in: packages/core/src/session/auth.ts:464

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

reopenPod()Copy Anchor Link

reopenPod(): Promise<void>;

Defined in: packages/core/src/session/auth.ts:417

Opens again the pod named in podToReopen, signed in if it was kept so. Needs a click.

ReturnsCopy Anchor Link

Promise<void>

select()Copy Anchor Link

select(accountId): Promise<void>;

Defined in: packages/core/src/session/auth.ts:424

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

setPassword()Copy Anchor Link

setPassword(password): Promise<boolean>;

Defined in: packages/core/src/session/auth.ts:468

Sets or replaces the account's password. During setup, moves the flow on; otherwise needs confirm first.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

settled()Copy Anchor Link

settled(): Promise<void>;

Defined in: packages/core/src/session/auth.ts:451

Resolves once the work setup began in the background is done: the username's claim, the host's handover

ReturnsCopy Anchor Link

Promise<void>

showExisting()Copy Anchor Link

showExisting(): void;

Defined in: packages/core/src/session/auth.ts:435

"I already have an account": the ways to reach one from here

ReturnsCopy Anchor Link

void

showRestore()Copy Anchor Link

showRestore(): void;

Defined in: packages/core/src/session/auth.ts:437

The recovery code form, for the selected account if there is one

ReturnsCopy Anchor Link

void

showSignIn()Copy Anchor Link

showSignIn(): void;

Defined in: packages/core/src/session/auth.ts:431

ReturnsCopy Anchor Link

void

showWelcome()Copy Anchor Link

showWelcome(): void;

Defined in: packages/core/src/session/auth.ts:433

Back to "new here, or not?"

ReturnsCopy Anchor Link

void

signInWithCode()Copy Anchor Link

signInWithCode(code): Promise<void>;

Defined in: packages/core/src/session/auth.ts:426

Opens an account with its recovery code. Where it has no passkey or password yet, sets one up next.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

signInWithPasskey()Copy Anchor Link

signInWithPasskey(): Promise<void>;

Defined in: packages/core/src/session/auth.ts:429

ReturnsCopy Anchor Link

Promise<void>

signInWithPassword()Copy Anchor Link

signInWithPassword(password): Promise<void>;

Defined in: packages/core/src/session/auth.ts:428

Opens the selected account with its password. A recovery code typed or filled here works too.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

signOut()Copy Anchor Link

signOut(options?): Promise<void>;

Defined in: packages/core/src/session/auth.ts:570

Signs this home out on this device: it forgets the unlocked account, lets apps whose time has passed go, and revokes its own session key. The apps connected from here keep their notes until they run out, as apps stay signed in when you sign out of where you signed in to them. { disconnect: true } disconnects them first, and the programs connected through them: their keys are revoked, and each sees it and asks to connect again. Carriers stay: they hold nothing that writes.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

start()Copy Anchor Link

start(): Promise<void>;

Defined in: packages/core/src/session/auth.ts:413

Looks for accounts and resumes a kept sign-in. Safe to call more than once.

ReturnsCopy Anchor Link

Promise<void>

startCreating()Copy Anchor Link

startCreating(): void;

Defined in: packages/core/src/session/auth.ts:430

ReturnsCopy Anchor Link

void

subscribe()Copy Anchor Link

subscribe(listener): () => void;

Defined in: packages/core/src/session/auth.ts:411

Called after every change. Returns a function that stops it.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

() => void

useBrowser()Copy Anchor Link

useBrowser(): Promise<void>;

Defined in: packages/core/src/session/auth.ts:421

Keeps accounts in this browser, and stops using a pod if one was open

ReturnsCopy Anchor Link

Promise<void>