Class RoomBridgeStore

Base class for bridge stores.

Hierarchy (view full)

BridgeStore
- RoomBridgeStore

Constructors

constructor

new RoomBridgeStore(db): RoomBridgeStore
Construct a store suitable for room bridging information. Data is stored as RoomBridgeStoreEntrys which have the following serialized format:
```
{
  id: "unique_id",      // customisable
  matrix_id: "room_id",
  remote_id: "remote_room_id",
  matrix: { serialised matrix room info },
  remote: { serialised remote room info },
  data: { ... any additional info ... }
}
```
If a unique 'id' is not given, the store will generate one by concatenating the matrix_id and the remote_id. The delimiter used is a property on this store and can be modified.

The structure of Entry objects means that it is efficient to select based off the 'id', 'matrix_id' or 'remote_id'. Additional indexes can be added manually.
Parameters
- db: Nedb<any>
  The connected NEDB database instance
Returns RoomBridgeStore
Overrides BridgeStore.constructor
- Defined in src/components/room-bridge-store.ts:92

Properties

`Readonly` db

db: Nedb<any>

delimiter

delimiter: string = " "

Methods

batchGetLinkedRemoteRooms

batchGetLinkedRemoteRooms(matrixIds): Promise<{
[roomId: string]: RemoteRoom[];
}>
A batched version of getLinkedRemoteRooms.
Parameters
- matrixIds: string[]
Returns Promise<{
[roomId: string]: RemoteRoom[];
}>
A mapping of room_id to RemoteRoom.

See
RoomBridgeStore#getLinkedRemoteRooms
- Defined in src/components/room-bridge-store.ts:267

convertTo

convertTo<T, O>(func): ((doc) => O)
Convenience method to convert a document to something.
Type Parameters
- T
- O
Parameters
- func: ((input) => O)
  The function which will be called with a single document object. Guaranteed not to be null.
  - - (input): O
    - Parameters
      input: T
      Returns O
Returns ((doc) => O)
A transformFn function to pass to the standard select/delete/upsert/etc methods.
- - (doc): O
  - Parameters
    - doc: T
    Returns O
Inherited from BridgeStore.convertTo
- Defined in src/components/bridge-store.ts:134

delete

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

getEntriesByLinkData

getEntriesByLinkData(data): Promise<RoomBridgeStoreEntry[]>
Get a list of entries based on the link's data value.
Parameters
- data: Record<string, unknown>
  The data values to retrieve based from.
Returns Promise<RoomBridgeStoreEntry[]>
Example
```
store.linkRooms(matrixRoom, remoteRoom, { some_key: "some_val" });
store.getEntriesByLinkData({
    some_key: "some_val"
});
```
- Defined in src/components/room-bridge-store.ts:332

getEntriesByMatrixId

getEntriesByMatrixId(matrixId): Promise<RoomBridgeStoreEntry[]>
Get a list of entries based on the matrix_id of each entry.
Parameters
- matrixId: string
Returns Promise<RoomBridgeStoreEntry[]>
- Defined in src/components/room-bridge-store.ts:122

getEntriesByMatrixIds

getEntriesByMatrixIds(ids): Promise<{
[matrixId: string]: RoomBridgeStoreEntry[];
}>
A batch version of getEntriesByMatrixId.
Parameters
- ids: string[]
Returns Promise<{
[matrixId: string]: RoomBridgeStoreEntry[];
}>
Resolves to a map of room_id => Entry[]
- Defined in src/components/room-bridge-store.ts:135

getEntriesByMatrixRoomData

getEntriesByMatrixRoomData(data): Promise<RoomBridgeStoreEntry[]>
Get a list of entries based on a MatrixRoom data value.
Parameters
- data: Record<string, unknown>
  The data values to retrieve based from.
Returns Promise<RoomBridgeStoreEntry[]>
Example
```
matrixRoom.set("some_key", "some_val");
// store matrixRoom and then:
store.getEntriesByMatrixRoomData({
    some_key: "some_val"
});
```
- Defined in src/components/room-bridge-store.ts:312

getEntriesByRemoteId

getEntriesByRemoteId(remoteId): Promise<RoomBridgeStoreEntry[]>
Get a list of entries based on the remote_id of each entry.
Parameters
- remoteId: string
Returns Promise<RoomBridgeStoreEntry[]>
- Defined in src/components/room-bridge-store.ts:162

getEntriesByRemoteRoomData

getEntriesByRemoteRoomData(data): Promise<RoomBridgeStoreEntry[]>
Get a list of entries based on a RemoteRoom data value.
Parameters
- data: Record<string, unknown>
  The data values to retrieve based from.
Returns Promise<RoomBridgeStoreEntry[]>
Example
```
remoteRoom.set("some_key", "some_val");
// store remoteRoom and then:
store.getEntriesByRemoteRoomData({
    some_key: "some_val"
});
```
- Defined in src/components/room-bridge-store.ts:291

getEntryById

getEntryById(id): Promise<null | RoomBridgeStoreEntry>
Get an existing entry based on the provided entry ID.
Parameters
- id: string
  The ID of the entry to retrieve.
Returns Promise<null | RoomBridgeStoreEntry>
- Defined in src/components/room-bridge-store.ts:110

getLinkedMatrixRooms

getLinkedMatrixRooms(remoteId): Promise<MatrixRoom[]>
Get all entries with the given remote_id which have a Matrix room within.
Parameters
- remoteId: string
Returns Promise<MatrixRoom[]>
- Defined in src/components/room-bridge-store.ts:233

getLinkedRemoteRooms

getLinkedRemoteRooms(matrixId): Promise<RemoteRoom[]>
Get all entries with the given matrix_id which have a Remote room within.
Parameters
- matrixId: string
Returns Promise<RemoteRoom[]>
- Defined in src/components/room-bridge-store.ts:249

getMatrixRoom

getMatrixRoom(roomId): Promise<undefined | null | MatrixRoom>
Get an entry's Matrix room based on the provided room_id. The entry MUST have an 'id' of the room_id and there MUST be a Matrix room contained within the entry for this to return.
Parameters
- roomId: string
Returns Promise<undefined | null | MatrixRoom>
See
RoomBridgeStore#setMatrixRoom
- Defined in src/components/room-bridge-store.ts:223

insert

insert(objects): 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, insertObj): 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

linkRooms

linkRooms(matrixRoom, remoteRoom, data?, linkId?): Promise<void>
Create a link between a matrix room and remote room. This will create an entry with:
- The matrix_id set to the matrix room ID.
- The remote_id set to the remote room ID.
- The id set to the id value given OR a concatenation of the matrix and remote IDs if one is not provided.
Parameters
- matrixRoom: MatrixRoom
  The matrix room
- remoteRoom: RemoteRoom
  The remote room
- data: Record<string, unknown> = {}
  Information about this mapping.
- Optional linkId: string
  The id value to set. If not given, a unique ID will be created from the matrix_id and remote_id.
Returns Promise<void>
- Defined in src/components/room-bridge-store.ts:182

removeEntriesByLinkData

removeEntriesByLinkData(data): Promise<number>
Remove entries based on the link's data value.
Parameters
- data: Record<string, unknown>
  The data to match.
Returns Promise<number>
Example
```
store.linkRooms(matrixRoom, remoteRoom, { a_key: "a_val" });
store.removeEntriesByLinkData({
    a_key: "a_val"
});
```
- Defined in src/components/room-bridge-store.ts:418

removeEntriesByMatrixRoomData

removeEntriesByMatrixRoomData(data): Promise<number>
Remove entries based on matrix room data.
Parameters
- data: Record<string, unknown>
  The data to match.
Returns Promise<number>
Example
```
matrixRoom.set("a_key", "a_val");
// store matrixRoom and then:
store.removeEntriesByMatrixRoomData({
    a_key: "a_val"
});
```
- Defined in src/components/room-bridge-store.ts:386

removeEntriesByMatrixRoomId

removeEntriesByMatrixRoomId(matrixId): Promise<number>
Remove entries with this matrix room id.
Parameters
- matrixId: string
  The matrix id.
Returns Promise<number>
Example
```
new MatrixRoom("!foobar:matrix.org");
// store the MatrixRoom and then:
store.removeEntriesByMatrixRoomId("!foobar:matrix.org");
```
- Defined in src/components/room-bridge-store.ts:403

removeEntriesByRemoteRoomData

removeEntriesByRemoteRoomData(data): Promise<number>
Remove entries based on remote room data.
Parameters
- data: Record<string, unknown>
  The data to match.
Returns Promise<number>
Example
```
remoteRoom.set("a_key", "a_val");
// store remoteRoom and then:
store.removeEntriesByRemoteRoomData({
    a_key: "a_val"
});
```
- Defined in src/components/room-bridge-store.ts:353

removeEntriesByRemoteRoomId

removeEntriesByRemoteRoomId(remoteId): Promise<number>
Remove entries with this remote room id.
Parameters
- remoteId: string
  The remote id.
Returns Promise<number>
Example
```
new RemoteRoom("foobar");
// store the RemoteRoom and then:
store.removeEntriesByRemoteRoomId("foobar");
```
- Defined in src/components/room-bridge-store.ts:370

removeEntryById

removeEntryById(id): Promise<number>
Remove an existing entry based on the provided entry ID.
Parameters
- id: string
  The ID of the entry to remove.
Returns Promise<number>
Example
```
store.removeEntryById("anid");
```
- Defined in src/components/room-bridge-store.ts:433

select

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

selectOne

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

setMatrixRoom

setMatrixRoom(matrixRoom): Promise<void>
Create an entry with only a matrix room. Sets the 'id' of the entry to the Matrix room ID. If an entry already exists with this 'id', it will be replaced. This function is useful if you just want to store a room with some data and not worry about any mappings.
Parameters
- matrixRoom: MatrixRoom
Returns Promise<void>
See
RoomBridgeStore#getMatrixRoom
- Defined in src/components/room-bridge-store.ts:207

setUnique

setUnique(fieldName, sparse?): 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

update

update(query, updateVals): 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, updateVals): 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

upsertEntry

upsertEntry(entry): Promise<void>
Insert an entry, clobbering based on the ID of the entry.
Parameters
- entry: RoomBridgeStoreEntry
Returns Promise<void>
- Defined in src/components/room-bridge-store.ts:100

`Static` createUniqueId

createUniqueId(matrixRoomId, remoteRoomId, delimiter): string
Parameters
- matrixRoomId: string
- remoteRoomId: string
- delimiter: string
Returns string
- Defined in src/components/room-bridge-store.ts:438

Class RoomBridgeStore

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: Nedb<any>

Returns RoomBridgeStore

Properties

Readonly db

delimiter

Methods

batchGetLinkedRemoteRooms

Parameters

matrixIds: string[]

Returns Promise<{ [roomId: string]: RemoteRoom[]; }>

See

convertTo

Type Parameters

T

O

Parameters

func: ((input) => O)

Parameters

input: T

Returns O

Returns ((doc) => O)

Parameters

doc: T

Returns O

delete

Parameters

query: Query

Returns Promise<number>

getEntriesByLinkData

Parameters

data: Record<string, unknown>

Returns Promise<RoomBridgeStoreEntry[]>

Example

getEntriesByMatrixId

Parameters

matrixId: string

Returns Promise<RoomBridgeStoreEntry[]>

getEntriesByMatrixIds

Parameters

ids: string[]

Returns Promise<{ [matrixId: string]: RoomBridgeStoreEntry[]; }>

getEntriesByMatrixRoomData

Parameters

data: Record<string, unknown>

Returns Promise<RoomBridgeStoreEntry[]>

Example

getEntriesByRemoteId

Parameters

remoteId: string

Returns Promise<RoomBridgeStoreEntry[]>

getEntriesByRemoteRoomData

Parameters

data: Record<string, unknown>

Returns Promise<RoomBridgeStoreEntry[]>

Example

getEntryById

Parameters

id: string

Returns Promise<null | RoomBridgeStoreEntry>

getLinkedMatrixRooms

Parameters

remoteId: string

Returns Promise<MatrixRoom[]>

getLinkedRemoteRooms

Parameters

matrixId: string

Returns Promise<RemoteRoom[]>

getMatrixRoom

Parameters

roomId: string

Returns Promise<undefined | null | MatrixRoom>

`Readonly` db

Returns Promise<{
[roomId: string]: RemoteRoom[];
}>

Returns Promise<{
[matrixId: string]: RoomBridgeStoreEntry[];
}>

`Optional` linkId: string

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

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