Class Auth

constructor

• new Auth(api: Api): Auth

  Parameters

  • api: Api

  Returns Auth

user$

spoke

• get spoke(): null | string

  Returns null | string

user

• get user(): undefined | null | User

  Current user

  Returns undefined | null | User
• set user(user: undefined | null | User): void

  Set current user info

  Parameters

  • user: undefined | null | User

  Returns void

current

• current(token?: null | string): Promise<null | User>

  Get current user associated with API token

  Parameters

  • token: null | string = ...

  Returns Promise<null | User>

handleLogin

• handleLogin(spoke: string, options?: LoginPromptOptions): Promise<void>

  Automatically handle sessions by checking localStorage & URL parameters for a token & prompting user with a login screen if required

  Parameters

  • spoke: string

    Desired spoke
  • Optionaloptions: LoginPromptOptions

    Aesthetic options

  Returns Promise<void>

  Login complete

isAuthenticated

• isAuthenticated(): boolean

  Check whether user has a token

  Returns boolean

  True if session token authenticated

isGuest

• isGuest(): boolean

  Check if the current user is a guest

  Returns boolean

  True if guest

isSysAdmin

• isSysAdmin(): Promise<boolean>

  Check if user is a system administrator

  Returns Promise<boolean>

  True if system administrator

isTableAdmin

• isTableAdmin(): Promise<boolean>

  Check if user is a table administrator

  Returns Promise<boolean>

  True if table administrator

isUserAdmin

• isUserAdmin(): Promise<boolean>

  Check if user is a user administrator

  Returns Promise<boolean>

  True if user administrator

login

• login(
      spoke: string,
      login: string,
      password: string,
      opts?: { expire?: null | string; twoFactor?: string },
  ): Promise<User>

  Perform login and save the session token

  Parameters

  • spoke: string

    Override login spoke
  • login: string

    Login username or email
  • password: string

    Password for account
  • Optionalopts: { expire?: null | string; twoFactor?: string }

    2FA code & expire date (YYYY-MM-DD)

  Returns Promise<User>

  User account

loginGuest

• loginGuest(): Promise<User>

  Login as guest user

  Returns Promise<User>

  Guest account

loginPrompt

• loginPrompt(spoke: string, options?: LoginPromptOptions): LoginPrompt

  Create Login UI

  Parameters

  • spoke: string

    Desired spoke
  • Optionaloptions: LoginPromptOptions

    Aesthetic options

  Returns LoginPrompt

  Login prompt

logout

• logout(): Promise<{ closed: string; new: string }>

  Logout current user

  Returns Promise<{ closed: string; new: string }>

reset

• reset(login: string, newPassword: string, code?: string): Promise<any>

  Reset user account password

  Parameters

  • login: string

    User login
  • newPassword: string

    New password
  • Optionalcode: string

    Reset code sent with resetRequest

  Returns Promise<any>

  New session

resetRequest

• resetRequest(login: string, mode: "email" | "sms" | "voice"): Promise<any>

  Request reset code for user

  Parameters

  • login: string

    User to reset
  • mode: "email" | "sms" | "voice"

    Method of sending reset code

  Returns Promise<any>

  Unknown