Class ManagerAuth

Hierarchy

ApiConnection
- ManagerAuth

Index

Constructors

constructor

new ManagerAuth(baseUrl: string): ManagerAuth
Parameters
- baseUrl: string
Returns ManagerAuth
Overrides ApiConnection.constructor
- Defined in manager/auth.ts:18

Properties

`Protected` _jwt

_jwt: string = ''

`Protected` `Optional` _onAuthFailed

_onAuthFailed?: ((url: string) => void)

Type declaration

- (url: string): void
- Callback to run when a request returns status 401 (optional)
  Parameters
  - url: string
  Returns void

`Protected` `Optional` _requestFunc

_requestFunc?: RequestFunction

Custom request function (optional)

Accessors

jwt

set jwt(jwt: string): void
Parameters
- jwt: string
Returns void
Inherited from ApiConnection.jwt
- Defined in common/connection.ts:13

onAuthFailed

set onAuthFailed(callback: ((url: string) => void)): void
Parameters
- callback: ((url: string) => void)
  - - (url: string): void
    - Parameters
      
      url: string
      
      Returns void
Returns void
Inherited from ApiConnection.onAuthFailed
- Defined in common/connection.ts:29

requestFunc

set requestFunc(requestFunc: RequestFunction): void
Parameters
- requestFunc: RequestFunction
Returns void
Inherited from ApiConnection.requestFunc
- Defined in common/connection.ts:21

Methods

_request

_request<ResponseType>(url: string, method?: "GET" | "POST" | "PUT" | "DELETE", body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- method: "GET" | "POST" | "PUT" | "DELETE" = 'GET'
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection._request
- Defined in common/connection.ts:33

changePassword

changePassword(currentPassword: string, newPassword: string, totpToken: string): Promise<void>
Change the users password.
Parameters
- currentPassword: string
  
  The current password
- newPassword: string
  
  The new password
- totpToken: string
  
  The TOTP token
Returns Promise<void>
- Defined in manager/auth.ts:89

changePasswordStatus

changePasswordStatus(): Promise<changePasswordStatus>
Gets the status of a currently in-progress change password operation.

Returns
The status of the password change

Returns Promise<changePasswordStatus>
- Defined in manager/auth.ts:110

`Protected` delete

delete<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.delete
- Defined in common/connection.ts:125

disableTotp

disableTotp(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in manager/auth.ts:187

enableTotp

enableTotp(key: string): Promise<void>
Actually enables TOTP by checking if a correct code is given.
Parameters
- key: string
  
  The TOTP key
Returns Promise<void>
- Defined in manager/auth.ts:181

`Protected` get

get<ResponseType>(url: string, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.get
- Defined in common/connection.ts:99

info

info(): Promise<user>
Retrieve information about the node's main account.

Returns
The user's data

Returns Promise<user>
- Defined in manager/auth.ts:61

isRegistered

isRegistered(): Promise<boolean>
Check if the node owner has an account

Returns
True if the user exists

Returns Promise<boolean>
- Defined in manager/auth.ts:119

isTotpEnabled

isTotpEnabled(): Promise<boolean>
Returns Promise<boolean>
- Defined in manager/auth.ts:193

login

login(password: string, totpToken: string): Promise<string>
Login to the node.

Returns
A JsonWebToken for the user
Parameters
- password: string
  
  The users password
- totpToken: string
  
  The TOTP token
Returns Promise<string>
- Defined in manager/auth.ts:28

`Protected` post

post<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.post
- Defined in common/connection.ts:107

`Protected` put

put<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.put
- Defined in common/connection.ts:116

refresh

refresh(): Promise<string>
Refresh the users login JWT

Returns
A new JWT for the user

Returns Promise<string>
- Defined in manager/auth.ts:48

register

register(username: string, password: string, seed: string[]): Promise<{ backupId?: string; jwt: string }>
Register a new user. Currently, this is only possible if no one is registered yet.

Returns
A JsonWebToken for the user
Parameters
- username: string
  
  The users name
- password: string
  
  The users password
- seed: string[]
  
  The mnemonic seed for the users wallet (LND aezeed)
Returns Promise<{ backupId?: string; jwt: string }>
- Defined in manager/auth.ts:132

seed

seed(password: string, totpToken?: string): Promise<string[]>
Retrieve the users mnemonic seed.

Returns
The mnemonic seed
Parameters
- password: string
  
  The users password as plain text
- Optional totpToken: string
Returns Promise<string[]>
- Defined in manager/auth.ts:155

setupTotp

setupTotp(): Promise<string>
Sets up TOTP for the user.

Returns
The TOTP key

Returns Promise<string>
- Defined in manager/auth.ts:173

test

test(): Promise<boolean>
Check if the login worked and the user is still connected

Returns
True if the user is logged in

Returns Promise<boolean>
- Defined in manager/auth.ts:70

Class ManagerAuth

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

baseUrl: string

Returns ManagerAuth

Properties

Protected _jwt

Protected Optional _onAuthFailed

Type declaration

Parameters

url: string

Returns void

Protected Optional _requestFunc

Accessors

jwt

Parameters

jwt: string

Returns void

onAuthFailed

Parameters

callback: ((url: string) => void)

Parameters

url: string

Returns void

Returns void

requestFunc

Parameters

requestFunc: RequestFunction

Returns void

Methods

_request

Type Parameters

ResponseType = unknown

Parameters

url: string

method: "GET" | "POST" | "PUT" | "DELETE" = 'GET'

body: unknown = {}

auth: boolean = true

blob: boolean = false

Returns Promise<ResponseType>

changePassword

Parameters

currentPassword: string

newPassword: string

totpToken: string

Returns Promise<void>

changePasswordStatus

Returns

Returns Promise<changePasswordStatus>

Protected delete

Type Parameters

ResponseType = unknown

Parameters

url: string

body: unknown = {}

auth: boolean = true

blob: boolean = false

Returns Promise<ResponseType>

disableTotp

Parameters

key: string

Returns Promise<void>

enableTotp

Parameters

key: string

Returns Promise<void>

Protected get

Type Parameters

ResponseType = unknown

Parameters

url: string

auth: boolean = true

blob: boolean = false

`Protected` _jwt

`Protected` `Optional` _onAuthFailed

`Protected` `Optional` _requestFunc

`Protected` delete

`Protected` get

`Protected` post

`Protected` put

`Optional` totpToken: string