Class OfflineVault

constructor

• new OfflineVault(
      enabled: boolean,
      options?: OfflineLoginOptions,
      startOffline?: boolean,
  ): OfflineVault

  Parameters

  • enabled: boolean
  • options: OfflineLoginOptions = {}
  • OptionalstartOffline: boolean

  Returns OfflineVault

Readonlyenabled

Readonlyready

Readonlyunlocked$

needsPassword

• get needsPassword(): boolean

  A saved offline login exists, but this session has not unlocked it yet

  Returns boolean

unlocked

• get unlocked(): boolean

  Returns boolean

forget

• forget(): Promise<void>

  Remove offline login completely; anything sealed becomes unreadable

  Returns Promise<void>

getProfile

• getProfile<T = any>(): Promise<null | T>

  Read the cached user profile; null while locked

  Type Parameters

  • T = any

  Returns Promise<null | T>

has

• has(realm: string, uid: number): boolean

  Saved offline login matches this user

  Parameters

  • realm: string
  • uid: number

  Returns boolean

lock

• lock(): Promise<void>

  Drop the in-memory and device keys but keep the password copy (queued work stays recoverable)

  Returns Promise<void>

open

• open<T>(value: any): Promise<undefined | T>

  Decrypt a value from IndexedDB. Unreadable values (old key / other user) return undefined.

  Type Parameters

  • T

  Parameters

  • value: any

  Returns Promise<undefined | T>

rememberLogin

• rememberLogin(
      realm: string,
      login: string,
      uid: number,
      password: string,
  ): Promise<void>

  Called after a successful online password login. Wraps the data key with the password so this user can sign in offline later.

  Parameters

  • realm: string
  • login: string
  • uid: number
  • password: string

  Returns Promise<void>

seal

• seal<T>(value: T): Promise<Sealed | T>

  Encrypt a value for IndexedDB (passes through when disabled)

  Type Parameters

  • T

  Parameters

  • value: T

  Returns Promise<Sealed | T>

setProfile

• setProfile(user: any): Promise<void>

  Save the cached user profile (sealed when enabled)

  Parameters

  • user: any

  Returns Promise<void>

touch

• touch(realm: undefined | string, uid: undefined | number): void

  The server confirmed this user's session: restart the offline window

  Parameters

  • realm: undefined | string
  • uid: undefined | number

  Returns void

unlockOffline

• unlockOffline(
      realm: string,
      login: string,
      uid: undefined | number,
      password: string,
  ): Promise<OfflineUnlockResult>

  Try to unlock offline with a password

  Parameters

  • realm: string
  • login: string
  • uid: undefined | number
  • password: string

  Returns Promise<OfflineUnlockResult>

whenUnlocked

• whenUnlocked(): Promise<boolean>

  Wait until the data key is available (resolves immediately when the vault is disabled)

  Returns Promise<boolean>