jazz-browser
Auth Providers
BrowserPasskeyAuth provides a JazzAuth object for passkey authentication.import { BrowserPasskeyAuth } from "jazz-browser";
const auth = new BrowserPasskeyAuth(driver, appName);type SessionProvider
type SessionProviderundefined = (accountID: AgentID | ID<Account>) => Promise<SessionID>
Invite Links
function
createInviteLink<C>(value, role, { baseURL?, valueHint? }):
{} stringfunction fn(...args: [
value: C,
role: "writeOnly" | "admin" | "writer" | "reader",
{ baseURL: string, valueHint: string }
]) {}function
consumeInviteLinkFromWindowLocation<V>({ invitedObjectSchema, as?, forValueHint? }):
{} Promise<{ valueID: ID<V>, inviteSecret: TODO type templateLiteral, valueHint: string } | undefined>function fn(...args: [
{ invitedObjectSchema: CoValueClass<V>, as: Account, forValueHint: string }
]) {}function
parseInviteLink<C>(inviteURL):
{} { valueID: ID<C>, inviteSecret: TODO type templateLiteral, valueHint: string } | undefinedfunction fn(...args: [
inviteURL: string
]) {}Other
function
createJazzBrowserGuestContext(options):
{} Promise<{ guest: AnonymousJazzAgent, node: LocalNode, done: () => void, logOut: () => Promise<void> }>function fn(...args: [
options: BaseBrowserContextOptions
]) {}function
createJazzBrowserContext<Acc>(options):
{} Promise<{ me: Acc, node: LocalNode, authSecretStorage: AuthSecretStorage, done: () => void, logOut: () => Promise<void> }>function fn(...args: [
options: BrowserContextOptions<Acc>
]) {}function
provideBrowserLockSession(accountID, crypto):
{} Promise<{ sessionID: TODO type templateLiteral | TODO type templateLiteral, sessionDone: () => void }>function fn(...args: [
accountID: TODO type templateLiteral | ID<Account>,
crypto: CryptoProvider
]) {}type BaseBrowserContextOptions
type BaseBrowserContextOptionsundefined = { sync: SyncConfig, authSecretStorage: AuthSecretStorage, reconnectionTimeout: number, storage: StorageConfig, crypto: CryptoProvider }
type BrowserContextOptions
type BrowserContextOptions<Acc extends Account> = { credentials: AuthCredentials, AccountSchema: CoValueClass<Acc> & { fromNode: Account["fromNode"] }, newAccountProps: NewAccountProps, defaultProfileName: string } & BaseBrowserContextOptions
type JazzContextManagerProps
type JazzContextManagerProps<Acc extends Account> = { sync: SyncConfig, guestMode: boolean, onLogOut: () => void, logOutReplacement: () => void, onAnonymousAccountDiscarded: (anonymousAccount: Acc) => Promise<void>, storage: BaseBrowserContextOptions["storage"], AccountSchema: AccountClass<Acc>, defaultProfileName: string }
class Thing<
Acc extends Account
]> {}