Class BasePasswordStore

A PasswordStore that uses a KeyValueStorage to store the entries. Passwords are hashed and salted. Default saltRounds is 10.

Hierarchy

Initializer
- BasePasswordStore

Implements

PasswordStore

Index

Constructors

constructor

new BasePasswordStore(storage, saltRounds?): BasePasswordStore
Parameters
- storage: AccountLoginStorage<Record<string, never>>
- saltRounds: number = 10
Returns BasePasswordStore
Overrides Initializer.constructor
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:33

Properties

`Private` initialized

initialized: boolean = false

`Private` `Readonly` logger

logger: Logger = ...

`Private` `Readonly` saltRounds

saltRounds: number

`Private` `Readonly` storage

storage: AccountLoginStorage<{
    password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    };
}>

Type declaration

password: {
    accountId: "id:account";
    email: "string";
    password: "string";
    verified: "boolean";
}
- Readonly accountId: "id:account"
- Readonly email: "string"
- Readonly password: "string"
- Readonly verified: "boolean"

Methods

authenticate

authenticate(email, password): Promise<{
accountId: string;
id: string;
}>
Authenticate if the email and password are correct and return the account and login ID if they are. Throw an error if they are not.
Parameters
- email: string
  
  The user's email.
- password: string
  
  This user's password.
Returns Promise<{
accountId: string;
id: string;
}>
Implementation of PasswordStore.authenticate
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:101

canHandle

canHandle(input): Promise<void>
Checks whether the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.
Parameters
- input: void
  
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from Initializer.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:18

confirmVerification

confirmVerification(id): Promise<void>
Confirms that the login has been verified. This can be used with, for example, email verification. The login can only be used after it is verified. In case verification is not required, this should be called immediately after the create call.
Parameters
- id: string
  
  ID of the login.
Returns Promise<void>
Implementation of PasswordStore.confirmVerification
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:92

create

create(email, accountId, password): Promise<string>
Creates a new login entry for this account.
Parameters
- email: string
  
  Email to log in with.
- accountId: string
  
  Account ID.
- password: string
  
  Password to authenticate with.
Returns Promise<string>
Implementation of PasswordStore.create
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:57

delete

delete(id): Promise<void>
Delete the login entry.
Parameters
- id: string
  
  ID of the login object.
Returns Promise<void>
Implementation of PasswordStore.delete
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:127

findByAccount

findByAccount(accountId): Promise<{
email: string;
id: string;
}[]>
Find all login objects created by this account.
Parameters
- accountId: string
  
  ID of the account to find the logins for.
Returns Promise<{
email: string;
id: string;
}[]>
Implementation of PasswordStore.findByAccount
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:87

findByEmail

findByEmail(email): Promise<undefined | {
accountId: string;
id: string;
}>
Finds the account and login ID associated with this email.
Parameters
- email: string
  
  Email to find the information for.
Returns Promise<undefined | {
accountId: string;
id: string;
}>
Implementation of PasswordStore.findByEmail
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:79

get

get(id): Promise<undefined | {
accountId: string;
email: string;
}>
Finds the account and email associated with this login ID.
Parameters
- id: string
  
  The ID of the login object.
Returns Promise<undefined | {
accountId: string;
email: string;
}>
Implementation of PasswordStore.get
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:71

handle

handle(): Promise<void>
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Returns Promise<void>
A promise resolving when handling is finished.
Overrides Initializer.handle
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:40

handleSafe

handleSafe(input): Promise<void>
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.
Parameters
- input: void
  
  Input data that will be handled if it can be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from Initializer.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:41

update

update(id, password): Promise<void>
Changes the password.
Parameters
- id: string
  
  ID of the login object.
- password: string
  
  The new password.
Returns Promise<void>
Implementation of PasswordStore.update
- Defined in src/identity/interaction/password/util/BasePasswordStore.ts:119

Class BasePasswordStore

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

storage: AccountLoginStorage<Record<string, never>>

saltRounds: number = 10

Returns BasePasswordStore

Properties

Private initialized

Private Readonly logger

Private Readonly saltRounds

Private Readonly storage

Type declaration

password: { accountId: "id:account"; email: "string"; password: "string"; verified: "boolean"; }

Readonly accountId: "id:account"

Readonly email: "string"

Readonly password: "string"

Readonly verified: "boolean"

Methods

authenticate

Parameters

email: string

password: string

Returns Promise<{ accountId: string; id: string; }>

canHandle

Parameters

input: void

Returns Promise<void>

confirmVerification

Parameters

id: string

Returns Promise<void>

create

Parameters

email: string

accountId: string

password: string

Returns Promise<string>

delete

Parameters

id: string

Returns Promise<void>

findByAccount

Parameters

accountId: string

Returns Promise<{ email: string; id: string; }[]>

findByEmail

Parameters

email: string

Returns Promise<undefined | { accountId: string; id: string; }>

get

Parameters

id: string

Returns Promise<undefined | { accountId: string; email: string; }>

handle

Returns Promise<void>

handleSafe

Parameters

input: void

Returns Promise<void>

update

Parameters

id: string

password: string

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Private` initialized

`Private` `Readonly` logger

`Private` `Readonly` saltRounds

`Private` `Readonly` storage

password: {
accountId: "id:account";
email: "string";
password: "string";
verified: "boolean";
}

`Readonly` accountId: "id:account"

`Readonly` email: "string"

`Readonly` password: "string"

`Readonly` verified: "boolean"

Returns Promise<{
accountId: string;
id: string;
}>

Returns Promise<{
email: string;
id: string;
}[]>

Returns Promise<undefined | {
accountId: string;
id: string;
}>

Returns Promise<undefined | {
accountId: string;
email: string;
}>