Class default

This class represents an 'Single User API without Credentials' authentication workflow.

Hierarchy (view full)

default
- default

Index

Constructors

Properties

onLogin onLogout

Methods

erase isRegistered login loginOrRegister logout logoutAndErase register registerWithKeys

Constructors

constructor

new default(options): default
Parameters
- options: Partial<AuthenticatorOptions>
Returns default
Inherited from default.constructor
- Defined in models/Authenticator/Authenticator.ts:95

Properties

onLogin

onLogin: OEvent<((instanceName: string, secret: string, email: string) => void)> = ...

This event will be triggered right AFTER the instance was initialised

onLogout

onLogout: OEvent<(() => void)> = ...

This event will be triggered right BEFORE the instance was closed

Methods

erase

erase(): Promise<void>
Erases the instance. This function will:
- delete the instance
- remove (if present) only workflow related store
Returns Promise<void>
- Defined in models/Authenticator/SingleUserNoAuth.ts:255

isRegistered

isRegistered(): Promise<boolean>
Checks if the user exists or not by checking the credentials in the store.

Returns Promise<boolean>
- Defined in models/Authenticator/SingleUserNoAuth.ts:238

login

login(): Promise<void>
Logins the user. This function will:
- trigger the 'login' event
- will check if there are any stored credentials
  - if no, it will throw an error and trigger 'login_failure' event
  - if yes, it will check if the instance exist
    - if no, it will throw an error and trigger 'login_failure' event
    - if yes, it will initialize the instance, import modules, register recipes trigger onLogin and wait for all the listeners to finish and trigger 'login_success' event
Returns Promise<void>
- Defined in models/Authenticator/SingleUserNoAuth.ts:174

loginOrRegister

loginOrRegister(): Promise<void>
This function will login or register based on the credentials existence in store.

Returns Promise<void>
- Defined in models/Authenticator/SingleUserNoAuth.ts:225

logout

logout(): Promise<void>
Logouts the user. This function will:
- trigger the 'logout' event
- trigger onLogout and wait for all the listeners to finish
- close the instance
- trigger the 'logout_done' event if it is successfully
Returns Promise<void>
Inherited from default.logout
- Defined in models/Authenticator/Authenticator.ts:119

logoutAndErase

logoutAndErase(): Promise<void>
Erases the current instance. This function will:
- trigger the 'logout' & onLogout events
- remove (if present) only workflow related store
- delete the instance
- trigger 'logout_done' event
Returns Promise<void>
Overrides default.logoutAndErase
- Defined in models/Authenticator/SingleUserNoAuth.ts:275

register

register(registerData?): Promise<void>
Registers the user with generated credentials. This function will:
- will check if there are any stored credentials
  - if no, it will persist the generated email, instance name & secret
  - if yes, continue
- will trigger the 'login' event
- will init the instance
- if successful
  - if yes, it will trigger the 'login_success' event
  - if no, it will throw error and trigger 'login_failure' event
Parameters
- OptionalregisterData: {
      email?: string;
      instanceName?: string;
      secret?: string;
  }
  - Optionalemail?: string
  - OptionalinstanceName?: string
  - Optionalsecret?: string
Returns Promise<void>
- Defined in models/Authenticator/SingleUserNoAuth.ts:43

registerWithKeys

registerWithKeys(secretEncryptionKey, secretSignKey, registerData?): Promise<void>
Parameters
- secretEncryptionKey: string | Uint8Array
- secretSignKey: string | Uint8Array
- OptionalregisterData: {
      email?: string;
      instanceName?: string;
      secret?: string;
  }
  - Optionalemail?: string
  - OptionalinstanceName?: string
  - Optionalsecret?: string
Returns Promise<void>
- Defined in models/Authenticator/SingleUserNoAuth.ts:93