Class UserBridgeStore

Base class for bridge stores.

Hierarchy (View Summary)

BridgeStore
- UserBridgeStore

Constructors

constructor

new UserBridgeStore(db: Nedb): UserBridgeStore
Construct a store suitable for user bridging information.
Parameters
- db: Nedb
  The connected NEDB database instance
Returns UserBridgeStore
Overrides BridgeStore.constructor
- Defined in src/components/user-bridge-store.ts:64

Properties

`Readonly`db

db: Nedb

Methods

convertTo

convertTo<T, O>(func: (input: T) => O): (doc: T) => O
Convenience method to convert a document to something.
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.
Returns (doc: T) => O
A transformFn function to pass to the standard select/delete/upsert/etc methods.
Inherited from BridgeStore.convertTo
- Defined in src/components/bridge-store.ts:134

delete

delete(query: Query): Promise<number>
DELETE multiple documents.
Parameters
- query: Query
Returns Promise<number>
Inherited from BridgeStore.delete
- Defined in src/components/bridge-store.ts:75

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.
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[]>
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
  })
});
```
- Defined in src/components/user-bridge-store.ts:239

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.
Parameters
- localpart: string
  The user localpart
Returns Promise<null | MatrixUser>
Resolves to a MatrixUser or null.
- Defined in src/components/user-bridge-store.ts:119

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.
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[]>
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
  })
});
```
- Defined in src/components/user-bridge-store.ts:199

getMatrixLinks

getMatrixLinks(remoteId: string): Promise<null | string[]>
Retrieve a list of matrix user IDs linked to this remote ID.
Parameters
- remoteId: string
  The remote ID
Returns Promise<null | string[]>
A list of user IDs.
- Defined in src/components/user-bridge-store.ts:335

getMatrixUser

getMatrixUser(userId: string): Promise<null | MatrixUser>
Get a matrix user by their user ID.
Parameters
- userId: string
  The user_id
Returns Promise<null | MatrixUser>
Resolves to the user or null if they do not exist. Rejects with an error if there was a problem querying the store.
- Defined in src/components/user-bridge-store.ts:134

getMatrixUsersFromRemoteId

getMatrixUsersFromRemoteId(remoteId: string): Promise<MatrixUser[]>
Retrieve a list of corresponding matrix users for the given remote ID.
Parameters
- remoteId: string
  The Remote ID
Returns Promise<MatrixUser[]>
Resolves to a list of Matrix users.
- Defined in src/components/user-bridge-store.ts:95

getRemoteLinks

getRemoteLinks(matrixId: string): Promise<null | string[]>
Retrieve a list of remote IDs linked to this matrix user ID.
Parameters
- matrixId: string
  The matrix user ID
Returns Promise<null | string[]>
A list of remote IDs.
- Defined in src/components/user-bridge-store.ts:350

getRemoteUser

getRemoteUser(id: string): Promise<null | RemoteUser>
Get a remote user by their remote ID.
Parameters
- id: string
  The remote ID
Returns Promise<null | RemoteUser>
Resolves to the user or null if they do not exist. Rejects with an error if there was a problem querying the store.
- Defined in src/components/user-bridge-store.ts:165

getRemoteUsersFromMatrixId

getRemoteUsersFromMatrixId(userId: string): Promise<RemoteUser[]>
Retrieve a list of corresponding remote users for the given matrix user ID.
Parameters
- userId: string
  The Matrix user ID
Returns Promise<RemoteUser[]>
Resolves to a list of Remote users.
- Defined in src/components/user-bridge-store.ts:73

insert

insert(objects: unknown): Promise<any[]>
INSERT a multiple documents.
Parameters
- objects: unknown
Returns Promise<any[]>
Inherited from BridgeStore.insert
- Defined in src/components/bridge-store.ts:43

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
- Defined in src/components/bridge-store.ts:57

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>
- Defined in src/components/user-bridge-store.ts:278

select

select<T, O>(query: Query, transformFn?: (input: T) => O): Promise<O[]>
SELECT a number of documents.
Type Parameters
- T
- O
Parameters
- query: Query
- OptionaltransformFn: (input: T) => O
Returns Promise<O[]>
Inherited from BridgeStore.select
- Defined in src/components/bridge-store.ts:99

selectOne

selectOne<T, O>(query: Query, transformFn?: (input: T) => O): Promise<null | O>
SELECT a single document.
Type Parameters
- T
- O
Parameters
- query: Query
- OptionaltransformFn: (input: T) => O
Returns Promise<null | O>
Inherited from BridgeStore.selectOne
- Defined in src/components/bridge-store.ts:82

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>
- Defined in src/components/user-bridge-store.ts:148

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>
- Defined in src/components/user-bridge-store.ts:259

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
- Defined in src/components/bridge-store.ts:119

unlinkUserIds

unlinkUserIds(matrixUserId: string, remoteUserId: string): Promise<number>
Delete a link between a matrix user ID and a remote user ID.
Parameters
- matrixUserId: string
  The matrix user ID
- remoteUserId: string
  The remote user ID
Returns Promise<number>
Resolves to the number of entries removed.
- Defined in src/components/user-bridge-store.ts:322

unlinkUsers

unlinkUsers(matrixUser: MatrixUser, remoteUser: RemoteUser): Promise<number>
Delete a link between a matrix user and a remote user.
Parameters
- matrixUser: MatrixUser
  The matrix user
- remoteUser: RemoteUser
  The remote user
Returns Promise<number>
Resolves to the number of entries removed.
- Defined in src/components/user-bridge-store.ts:312

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
- Defined in src/components/bridge-store.ts:68

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
- Defined in src/components/bridge-store.ts:50

Class UserBridgeStore

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserBridgeStore

Properties

Readonlydb

Methods

convertTo

Type Parameters

Parameters

Returns (doc: T) => O

delete

Parameters

Returns Promise<number>

getByMatrixData

Parameters

Returns Promise<MatrixUser[]>

Throws

Example

getByMatrixLocalpart

Parameters

Returns Promise<null | MatrixUser>

getByRemoteData

Parameters

Returns Promise<RemoteUser[]>

Throws

Example

getMatrixLinks

Parameters

Returns Promise<null | string[]>

getMatrixUser

Parameters

Returns Promise<null | MatrixUser>

getMatrixUsersFromRemoteId

Parameters

Returns Promise<MatrixUser[]>

getRemoteLinks

Parameters

Returns Promise<null | string[]>

getRemoteUser

Parameters

Returns Promise<null | RemoteUser>

getRemoteUsersFromMatrixId

Parameters

Returns Promise<RemoteUser[]>

insert

Parameters

Returns Promise<any[]>

insertIfNotExists

Parameters

Returns Promise<void>

linkUsers

Parameters

Returns Promise<void>

select

Type Parameters

Parameters

Returns Promise<O[]>

selectOne

Type Parameters

Parameters

Returns Promise<null | O>

setMatrixUser

Parameters

Returns Promise<void>

setRemoteUser

Parameters

Returns Promise<void>

setUnique

Parameters

Returns void

unlinkUserIds

Parameters

Returns Promise<number>

`Readonly`db