Class UserBridgeStore

Base class for bridge stores.

Hierarchy

BridgeStore
- UserBridgeStore

Constructors

constructor

new UserBridgeStore(db: Nedb<any>): UserBridgeStore
Construct a store suitable for user bridging information.
Parameters
- db: Nedb<any>
  
  The connected NEDB database instance
Returns UserBridgeStore

Overrides BridgeStore.constructor

Properties

`Readonly` db

db: Nedb<any>

Methods

convertTo

convertTo<T, O>(func: ((input: T) => O)): ((doc: T) => O)
Convenience method to convert a document to something.

Returns
A transformFn function to pass to the standard select/delete/upsert/etc methods.
Type Parameters
- T
- O
Parameters
- func: ((input: T) => O)
  
  The function which will be called with a single document object. Guaranteed not to be null.
  - - (input: T): O
    - Parameters
      
      input: T
      
      Returns O
Returns ((doc: T) => O)
- - (doc: T): O
  - Parameters
    - doc: T
    Returns O
Inherited from BridgeStore.convertTo

delete

delete(query: Query): Promise<number>
DELETE multiple documents.
Parameters
- query: Query
Returns Promise<number>

Inherited from BridgeStore.delete

getByMatrixData

getByMatrixData(dataQuery: Record<string, unknown>): Promise<MatrixUser[]>
Get Matrix users by some data about them, previously stored via the set method on the Matrix user.

Returns
Resolves to a possibly empty list of MatrixUsers. Rejects with an error if there was a problem querying the store.

Throws
If dataQuery isn't an object.

Example
```
matrixUser.set({
  toplevel: "foo",
  nested: {
    bar: {
      baz: 43
    }
  }
});
store.setMatrixUser(matrixUser).then(function() {
  store.getByMatrixData({
    "toplevel": "foo",
    "nested.bar.baz": 43
  })
});
```
Parameters
- dataQuery: Record<string, unknown>
  
  The keys and matching values the remote users share. This should use dot notation for nested types. For example: { "topLevel.midLevel.leaf": 42, "otherTopLevel": "foo" }
Returns Promise<MatrixUser[]>

getByMatrixLocalpart

getByMatrixLocalpart(localpart: string): Promise<null | MatrixUser>
Retrieve a MatrixUser based on their user ID localpart. If there is more than one match (e.g. same localpart, different domains) then this will return an arbitrary matching user.

Returns
Resolves to a MatrixUser or null.
Parameters
- localpart: string
  
  The user localpart
Returns Promise<null | MatrixUser>

getByRemoteData

getByRemoteData(dataQuery: Record<string, unknown>): Promise<RemoteUser[]>
Get remote users by some data about them, previously stored via the set method on the Remote user.

Returns
Resolves to a possibly empty list of RemoteUsers. Rejects with an error if there was a problem querying the store.

Throws
If dataQuery isn't an object.

Example
```
remoteUser.set({
  toplevel: "foo",
  nested: {
    bar: {
      baz: 43
    }
  }
});
store.setRemoteUser(remoteUser).then(function() {
  store.getByRemoteData({
    "toplevel": "foo",
    "nested.bar.baz": 43
  })
});
```
Parameters
- dataQuery: Record<string, unknown>
  
  The keys and matching values the remote users share. This should use dot notation for nested types. For example: { "topLevel.midLevel.leaf": 42, "otherTopLevel": "foo" }
Returns Promise<RemoteUser[]>

getMatrixLinks

getMatrixLinks(remoteId: string): Promise<null | string[]>
Retrieve a list of matrix user IDs linked to this remote ID.

Returns
A list of user IDs.
Parameters
- remoteId: string
  
  The remote ID
Returns Promise<null | string[]>

getMatrixUser

getMatrixUser(userId: string): Promise<null | MatrixUser>
Get a matrix user by their user ID.

Returns
Resolves to the user or null if they do not exist. Rejects with an error if there was a problem querying the store.
Parameters
- userId: string
  
  The user_id
Returns Promise<null | MatrixUser>

getMatrixUsersFromRemoteId

getMatrixUsersFromRemoteId(remoteId: string): Promise<MatrixUser[]>
Retrieve a list of corresponding matrix users for the given remote ID.

Returns
Resolves to a list of Matrix users.
Parameters
- remoteId: string
  
  The Remote ID
Returns Promise<MatrixUser[]>

getRemoteLinks

getRemoteLinks(matrixId: string): Promise<null | string[]>
Retrieve a list of remote IDs linked to this matrix user ID.

Returns
A list of remote IDs.
Parameters
- matrixId: string
  
  The matrix user ID
Returns Promise<null | string[]>

getRemoteUser

getRemoteUser(id: string): Promise<null | RemoteUser>
Get a remote user by their remote ID.

Returns
Resolves to the user or null if they do not exist. Rejects with an error if there was a problem querying the store.
Parameters
- id: string
  
  The remote ID
Returns Promise<null | RemoteUser>

getRemoteUsersFromMatrixId

getRemoteUsersFromMatrixId(userId: string): Promise<RemoteUser[]>
Retrieve a list of corresponding remote users for the given matrix user ID.

Returns
Resolves to a list of Remote users.
Parameters
- userId: string
  
  The Matrix user ID
Returns Promise<RemoteUser[]>

insert

insert(objects: unknown): Promise<any[]>
INSERT a multiple documents.
Parameters
- objects: unknown
Returns Promise<any[]>

Inherited from BridgeStore.insert

insertIfNotExists

insertIfNotExists(query: Query, insertObj: Record<string, unknown>): Promise<void>
INSERT IF NOT EXISTS a single document
Parameters
- query: Query
- insertObj: Record<string, unknown>
Returns Promise<void>

Inherited from BridgeStore.insertIfNotExists

linkUsers

linkUsers(matrixUser: MatrixUser, remoteUser: RemoteUser): Promise<void>
Create a link between a matrix and remote user. If either user does not exist, they will be inserted prior to linking. This is done to ensure foreign key constraints are satisfied (so you cannot have a mapping to a user ID which does not exist).
Parameters
- matrixUser: MatrixUser
  
  The matrix user
- remoteUser: RemoteUser
  
  The remote user
Returns Promise<void>

select

select<T, O>(query: Query, transformFn?: ((input: T) => O)): Promise<O[]>
SELECT a number of documents.
Type Parameters
- T
- O
Parameters
- query: Query
- Optional transformFn: ((input: T) => O)
  - - (input: T): O
    - Parameters
      
      input: T
      
      Returns O
Returns Promise<O[]>

Inherited from BridgeStore.select

selectOne

selectOne<T, O>(query: Query, transformFn?: ((input: T) => O)): Promise<null | O>
SELECT a single document.
Type Parameters
- T
- O
Parameters
- query: Query
- Optional transformFn: ((input: T) => O)
  - - (input: T): O
    - Parameters
      
      input: T
      
      Returns O
Returns Promise<null | O>

Inherited from BridgeStore.selectOne

setMatrixUser

setMatrixUser(matrixUser: MatrixUser): Promise<void>
Store a Matrix user. If they already exist, they will be updated. Equivalence is determined by their user ID.
Parameters
- matrixUser: MatrixUser
  
  The matrix user
Returns Promise<void>

setRemoteUser

setRemoteUser(remoteUser: RemoteUser): Promise<void>
Store a Remote user. If they already exist, they will be updated. Equivalence is determined by the Remote ID.
Parameters
- remoteUser: RemoteUser
  
  The remote user
Returns Promise<void>

setUnique

setUnique(fieldName: string, sparse?: boolean): void
Set a UNIQUE key constraint on the given field.
Parameters
- fieldName: string
  
  The field name. Use dot notation for nested objects.
- sparse: boolean = false
  
  Allow sparse entries (undefined won't cause a key violation).
Returns void

Inherited from BridgeStore.setUnique

unlinkUserIds

unlinkUserIds(matrixUserId: string, remoteUserId: string): Promise<number>
Delete a link between a matrix user ID and a remote user ID.

Returns
Resolves to the number of entries removed.
Parameters
- matrixUserId: string
  
  The matrix user ID
- remoteUserId: string
  
  The remote user ID
Returns Promise<number>

unlinkUsers

unlinkUsers(matrixUser: MatrixUser, remoteUser: RemoteUser): Promise<number>
Delete a link between a matrix user and a remote user.

Returns
Resolves to the number of entries removed.
Parameters
- matrixUser: MatrixUser
  
  The matrix user
- remoteUser: RemoteUser
  
  The remote user
Returns Promise<number>

update

update(query: Query, updateVals: Record<string, unknown>): Promise<void>
UPDATE a single document. If the document already exists, this will NOT update it.
Parameters
- query: Query
- updateVals: Record<string, unknown>
Returns Promise<void>

Inherited from BridgeStore.update

upsert

upsert<T>(query: Query, updateVals: T): Promise<void>
UPSERT a single document
Type Parameters
- T
Parameters
- query: Query
- updateVals: T
Returns Promise<void>

Inherited from BridgeStore.upsert

Class UserBridgeStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: Nedb<any>

Returns UserBridgeStore

Properties

Readonly db

Methods

convertTo

Returns

Type Parameters

T

O

Parameters

func: ((input: T) => O)

Parameters

input: T

Returns O

Returns ((doc: T) => O)

Parameters

doc: T

Returns O

delete

Parameters

query: Query

Returns Promise<number>

getByMatrixData

Returns

Throws

Example

Parameters

dataQuery: Record<string, unknown>

Returns Promise<MatrixUser[]>

getByMatrixLocalpart

Returns

Parameters

localpart: string

Returns Promise<null | MatrixUser>

getByRemoteData

Returns

Throws

Example

Parameters

dataQuery: Record<string, unknown>

Returns Promise<RemoteUser[]>

getMatrixLinks

Returns

Parameters

remoteId: string

Returns Promise<null | string[]>

getMatrixUser

Returns

Parameters

userId: string

Returns Promise<null | MatrixUser>

getMatrixUsersFromRemoteId

Returns

Parameters

remoteId: string

Returns Promise<MatrixUser[]>

getRemoteLinks

Returns

Parameters

matrixId: string

Returns Promise<null | string[]>

getRemoteUser

Returns

Parameters

id: string

Returns Promise<null | RemoteUser>

getRemoteUsersFromMatrixId

Returns

Parameters

userId: string

`Readonly` db

`Optional` transformFn: ((input: T) => O)

`Optional` transformFn: ((input: T) => O)