Class BaseLoginAccountStorage<T>

A LoginStorage that wraps around another IndexedStorage to add specific account requirements.

New accounts will be removed after expiration time, in seconds, default is 1800, if no login method was added to them in that time.
Non-login types can not be created until the associated account has at least 1 login method.
Login types can not be deleted if they are the last login of the associated account.

All of this is tracked by adding a new field to the account object, that keeps track of how many login objects are associated with the account.

Type Parameters

T extends IndexTypeCollection<T>

Hierarchy

BaseLoginAccountStorage

Implements

LoginStorage<T>

Index

Constructors

constructor

new BaseLoginAccountStorage<T>(storage, expiration?): BaseLoginAccountStorage<T>
Type Parameters
- T extends IndexTypeCollection<T>
Parameters
- storage: IndexedStorage<T>
- expiration: number = ...
Returns BaseLoginAccountStorage<T>
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:40

Properties

`Protected` `Readonly` accountKeys

accountKeys: Dict<string>

`Private` `Readonly` expiration

expiration: number

`Private` `Readonly` logger

logger: Logger = ...

`Protected` `Readonly` loginTypes

loginTypes: string[]

`Protected` `Readonly` storage

storage: IndexedStorage<T>

Methods

`Protected` checkAccount

checkAccount(type, accountId, add): Promise<void>
Makes sure of the operation, adding or removing an object of the given type, is allowed, based on the current amount of login methods on the given account.
Parameters
- type: string
- accountId: string
- add: boolean
Returns Promise<void>
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:171

`Protected` cleanOutput

cleanOutput<TVal>(this, value): TVal
Removes the field that keeps track of the login counts, to hide this from the output.
Type Parameters
- TVal extends undefined | Record<string, unknown>
Parameters
- this: void
- value: TVal
Returns TVal
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:193

create

create<TType>(type, value): Promise<TypeObject<T[TType]>>
Creates an object of the given type. The storage will generate an identifier for the newly created object.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type to create.
- value: CreateTypeObject<T[TType]>
  
  The value to set for the created object.
Returns Promise<TypeObject<T[TType]>>
A representation of the newly created object, including its new identifier.
Implementation of LoginStorage.create
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:68

`Protected` createAccountTimeout

createAccountTimeout(id): void
Creates a timer that removes the account with the given ID if it doesn't have a login method when the timer runs out.
Parameters
- id: string
Returns void
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:155

createIndex

createIndex<TType>(type, key): Promise<void>
Creates an index on a key of the given type, to allow for better queries involving those keys. Similar to IndexedStorage.defineType these calls need to happen first.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type to create an index on.
- key: StringKey<T[TType]>
  
  The key of that type to create an index on.
Returns Promise<void>
Implementation of LoginStorage.createIndex
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:64

defineType

defineType<TType>(type, description, isLogin): Promise<void>
Defines a type in the storage, just like in an IndexedStorage, but additionally it needs to be indicated if the type corresponds to a login method or not.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  Type to define.
- description: T[TType]
  
  Description of the type.
- isLogin: boolean
  
  Whether this type corresponds to a login method or not.
Returns Promise<void>
Implementation of LoginStorage.defineType
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:47

delete

delete<TType>(type, id): Promise<void>
Deletes the given object. This will also delete all objects that reference that object if the corresponding key is not optional.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type of the object to delete.
- id: string
  
  The identifier of the object.
Returns Promise<void>
Implementation of LoginStorage.delete
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:132

entries

entries<TType>(type): AsyncIterableIterator<TypeObject<T[TType]>>
Returns an iterator over all objects of the given type.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type to iterate over.
Returns AsyncIterableIterator<TypeObject<T[TType]>>
Implementation of LoginStorage.entries
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:145

find

find<TType>(type, query): Promise<TypeObject<T[TType]>[]>
Finds all objects matching a specific IndexedQuery.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type of objects to find.
- query: {
      [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
          ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
          : never)
  }
  
  The query to execute.
Returns Promise<TypeObject<T[TType]>[]>
A list of objects matching the query.
Implementation of LoginStorage.find
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:100

findIds

findIds<TType>(type, query): Promise<string[]>
Similar to IndexedStorage.find, but only returns the identifiers of the found objects.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type of objects to find.
- query: {
      [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
          ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
          : never)
  }
  
  The query to execute.
Returns Promise<string[]>
A list of identifiers of the matching objects.
Implementation of LoginStorage.findIds
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:105

get

get<TType>(type, id): Promise<undefined | TypeObject<T[TType]>>
Returns the object of the given type with the given identifier.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type of object to get.
- id: string
  
  The identifier of that object.
Returns Promise<undefined | TypeObject<T[TType]>>
A representation of the object, or undefined if there is no object of that type with that identifier.
Implementation of LoginStorage.get
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:96

has

has<TType>(type, id): Promise<boolean>
Returns true if the object of the given type with the given identifier exists.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type of object to get.
- id: string
  
  The identifier of that object.
Returns Promise<boolean>
Whether this object exists.
Implementation of LoginStorage.has
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:92

set

set<TType>(type, value): Promise<void>
Sets the value of a specific object. The identifier in the object is used to identify the object.
Type Parameters
- TType extends string
Parameters
- type: TType
  
  The type of the object to set.
- value: TypeObject<T[TType]>
  
  The new value for the object.
Returns Promise<void>
Implementation of LoginStorage.set
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:109

setField

setField<TType, TKey>(type, id, key, value): Promise<void>
Sets the value of one specific field in an object.
Type Parameters
- TType extends string
- TKey extends string
Parameters
- type: TType
  
  The type of the object to update.
- id: string
  
  The identifier of the object to update.
- key: TKey
  
  The key to update.
- value: ValueType<T[TType][TKey]>
  
  The new value for the given key.
Returns Promise<void>
Implementation of LoginStorage.setField
- Defined in src/identity/interaction/account/util/BaseLoginAccountStorage.ts:123

Class BaseLoginAccountStorage<T>

Type Parameters

T extends IndexTypeCollection<T>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends IndexTypeCollection<T>

Parameters

storage: IndexedStorage<T>

expiration: number = ...

Returns BaseLoginAccountStorage<T>

Properties

Protected Readonly accountKeys

Private Readonly expiration

Private Readonly logger

Protected Readonly loginTypes

Protected Readonly storage

Methods

Protected checkAccount

Parameters

type: string

accountId: string

add: boolean

Returns Promise<void>

Protected cleanOutput

Type Parameters

TVal extends undefined | Record<string, unknown>

Parameters

this: void

value: TVal

Returns TVal

create

Type Parameters

TType extends string

Parameters

type: TType

value: CreateTypeObject<T[TType]>

Returns Promise<TypeObject<T[TType]>>

Protected createAccountTimeout

Parameters

id: string

Returns void

createIndex

Type Parameters

TType extends string

Parameters

type: TType

key: StringKey<T[TType]>

Returns Promise<void>

defineType

Type Parameters

TType extends string

Parameters

type: TType

description: T[TType]

isLogin: boolean

Returns Promise<void>

delete

Type Parameters

TType extends string

Parameters

type: TType

id: string

Returns Promise<void>

entries

Type Parameters

TType extends string

Parameters

type: TType

Returns AsyncIterableIterator<TypeObject<T[TType]>>

find

Type Parameters

TType extends string

Parameters

`Protected` `Readonly` accountKeys

`Private` `Readonly` expiration

`Private` `Readonly` logger

`Protected` `Readonly` loginTypes

`Protected` `Readonly` storage

`Protected` checkAccount

`Protected` cleanOutput

`Protected` createAccountTimeout