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
createInviteLink<C>(value, role, { baseURL?, valueHint? }): stringvalue: C,
role: "writeOnly" | "admin" | "writer" | "reader",
{ baseURL: string, valueHint: string }consumeInviteLinkFromWindowLocation<V>({ invitedObjectSchema, as?, forValueHint? }): Promise<{ valueID: ID<V>, inviteSecret: InviteSecret, valueHint: string } | undefined>{ invitedObjectSchema: CoValueClass<V>, as: Account, forValueHint: string }parseInviteLink<C>(inviteURL): { valueID: ID<C>, inviteSecret: InviteSecret, valueHint: string } | undefinedinviteURL: stringOther
createJazzBrowserGuestContext(options): Promise<{ guest: AnonymousJazzAgent, node: LocalNode, done: () => void, logOut: () => Promise<void> }>options: BaseBrowserContextOptionscreateJazzBrowserContext<Acc>(options): Promise<{ me: Acc, node: LocalNode, authSecretStorage: AuthSecretStorage, done: () => void, logOut: () => Promise<void> }>options: BrowserContextOptions<Acc>provideBrowserLockSession(accountID, crypto): Promise<{ sessionID: TODO type templateLiteral | TODO type templateLiteral, sessionDone: () => void }>accountID: TODO type templateLiteral | ID<Account>,
crypto: CryptoProvider<any>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, onAnonymousAccountDiscarded: (anonymousAccount: Acc) => Promise<void>, storage: BaseBrowserContextOptions["storage"], AccountSchema: AccountClass<Acc>, defaultProfileName: string }
Acc extends Account