Database | dimensions-ai

The database plugin class, of which Dimensions uses internally to store data onto the database Must be extended in order to be used as a database plugin

Hierarchy

Plugin
- Database

Index

Enumerations

Type

Interfaces

Constructors

constructor

Properties

Methods

Object literals

configs

Constructors

constructor

new Database(configs: DeepPartial<Configs>): Database

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L14
Parameters
- configs: DeepPartial<Configs>
Returns Database

Properties

Abstract name

name: string

Name of the plugin

Abstract type

type: Type

Type of the plugin. Required in order for Dimensions to know how to use it

Static Database

Database: Database

Static Storage

Storage: Storage

Methods

Abstract deleteUser

deleteUser(usernameOrID: string): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L78
Deletes the user with this username or ID (generated nanoID)

Parameters
- usernameOrID: string
Returns Promise<any>

Abstract getMatch

getMatch(id: NanoID): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L45
Retrieves a match through its match ID

Parameters
- id: NanoID
  
  a NanoID
Returns Promise<any>

Abstract getPlayerMatches

getPlayerMatches(playerID: nanoid, governID: nanoid, offset: number, limit: number, order: number): Promise<Array<Match>>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L128
Resolves with match data

Parameters
- playerID: nanoid
  
  id of player to retrieve matches from
- governID: nanoid
  
  id of what created the matches. This can be a dimension ID or a tournament ID
- offset: number
  
  offset
- limit: number
  
  max number of matches to return
- order: number
  
  1 for ascending and -1 for descending in order of creation date
Returns Promise<Array<Match>>

Abstract getTournamentConfigs

getTournamentConfigs(tournamentID: nanoid): Promise<{ configs: TournamentConfigsBase; status: Tournament.Status }>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L140
Get configs for a tournament. Resolves with { configs: null, status: null } if no configs exist

Parameters
- tournamentID: nanoid
  
  id of the tournament to get configs for
Returns Promise<{ configs: TournamentConfigsBase; status: Tournament.Status }>

Abstract getTournamentConfigsModificationDate

getTournamentConfigsModificationDate(tournamentID: nanoid): Promise<Date>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L151
Gets the last modification date of the configs for the tournament with id tournamentID

Parameters
- tournamentID: nanoid
  
  id of tournament
Returns Promise<Date>

Abstract getUser

getUser(usernameOrID: string, publicView?: boolean): Promise<User>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L96
Gets user information. If publicView is true, will retrieve all non-sensitive information (so it should exclude password. Resolves with null if no user found

Parameters
- usernameOrID: string
- Optional publicView: boolean
Returns Promise<User>

Abstract getUsersInTournament

getUsersInTournament(tournamentKeyName: string, offset: number, limit: number): Promise<Array<User>>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L109
Gets all users with statistics in a tournament specified by the tournamentKeyName, which is a string that is the key stored in the user's statistics property mapping to the tournament's statistics. This is also the number of rankings.

Parameters
- tournamentKeyName: string
- offset: number
  
  offset of the users
- limit: number
  
  how many users to retrieve
Returns Promise<Array<User>>

Abstract initialize

initialize(dimension: Dimension): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L29
Performs any intialization tasks Resolves when done

Parameters
- dimension: Dimension
Returns Promise<any>

Abstract isAdmin

isAdmin(user: PublicUser): boolean

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L118
Returns true if the user info indicate the user is an admin

Parameters
- user: PublicUser
Returns boolean

Abstract loginUser

loginUser(username: string, password: string): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L52
Logs in a user, resolves with a JWT (JSON Web Token), rejects otherwise

Parameters
- username: string
  
  unique username to login with
- password: string
  
  the password for the user with that username
Returns Promise<any>

Abstract manipulate

manipulate(dimension: Dimension): Promise<void>

Inherited from Storage.manipulate
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/index.ts#L24
Manipulates the dimension as necessary for this plugin. Should resolve when done

Parameters
- dimension: Dimension
  
  the dimension the plugin is being applied on
Returns Promise<void>

Abstract registerUser

registerUser(username: string, password: string, userData?: any): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L60
Registers a user, resolves when succesful, rejects otherwise

Parameters
- username: string
  
  username to register with
- password: string
  
  the password for the user
- Optional userData: any
  
  any other kind of user data, (e.g email)
Returns Promise<any>

Abstract storeMatch

storeMatch(match: Match, governID: nanoid): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L39
Stores any match related data. Typically will just store match results

Parameters
- match: Match
  
  the match to store
- governID: nanoid
Returns Promise<any>

Abstract storeTournamentConfigs

storeTournamentConfigs(tournamentID: nanoid, tournamentConfigs: TournamentConfigsBase, status: TournamentStatus): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L161
Store configs and status for a tournament. Should overwrite any existing config data. Resolves if successful

Parameters
- tournamentID: nanoid
  
  id of the tournament to store for
- tournamentConfigs: TournamentConfigsBase
  
  configs to store
- status: TournamentStatus
  
  the status to store
Returns Promise<void>

Abstract updateUser

updateUser(usernameOrID: string, update: Partial<User>): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L85
Updates the user with this username or ID (generated nanoID) with the provided data

Parameters
- usernameOrID: string
- update: Partial<User>
Returns Promise<any>

Abstract verifyToken

verifyToken(jwt: string): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Database/index.ts#L72
Authenticates a user by a JWT, resolves with the token data signed in the loginUser function, rejects otherwise

Parameters
- jwt: string
  
  the token
Returns Promise<any>

Object literals

configs

configs: object

Default configs

saveMatches

saveMatches: true = true

saveTournamentMatches

saveTournamentMatches: true = true

Hierarchy

Index

Enumerations

Interfaces

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

configs: DeepPartial<Configs>

Returns Database

Properties

Abstract name

Abstract type

Static Database

Static Storage

Methods

Abstract deleteUser

Parameters

usernameOrID: string

Returns Promise<any>

Abstract getMatch

Parameters

id: NanoID

Returns Promise<any>

Abstract getPlayerMatches

Parameters

playerID: nanoid

governID: nanoid

offset: number

limit: number

order: number

Returns Promise<Array<Match>>

Abstract getTournamentConfigs

Parameters

tournamentID: nanoid

Returns Promise<{ configs: TournamentConfigsBase; status: Tournament.Status }>

Abstract getTournamentConfigsModificationDate

Parameters

tournamentID: nanoid

Returns Promise<Date>

Abstract getUser

Parameters

usernameOrID: string

Optional publicView: boolean

Returns Promise<User>

Abstract getUsersInTournament

Parameters

tournamentKeyName: string

offset: number

limit: number

Returns Promise<Array<User>>

Abstract initialize

Parameters

dimension: Dimension

Returns Promise<any>

Abstract isAdmin

Parameters

user: PublicUser

Returns boolean

Abstract loginUser

Parameters

username: string

password: string

Returns Promise<any>

Abstract manipulate

Parameters

dimension: Dimension

Returns Promise<void>

Abstract registerUser

Parameters

username: string

password: string

Optional userData: any

Returns Promise<any>

Abstract storeMatch

Parameters

match: Match