Class GestaltGraph

Hierarchy

CreateDestroyStartStop
- GestaltGraph

Index

Constructors

Properties

[initLock] acl db dbIdentitiesPath dbLinksPath dbMatrixPath dbNodesPath dbPath generateGestaltLinkId logger nodeClaimIdOldestPath vertexProcessedTimeOrderPath vertexProcessedTimePath

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Constructors

constructor

new GestaltGraph(__namedParameters): GestaltGraph
Parameters
- __namedParameters: {
      acl: ACL;
      db: DB;
      logger: Logger;
  }
  - acl: ACL
  - db: DB
  - logger: Logger
Returns GestaltGraph
Inherited from createDestroyStartStop.CreateDestroyStartStop.constructor
- Defined in src/gestalts/GestaltGraph.ts:133

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` acl

acl: ACL

`Protected` db

db: DB

`Readonly` dbIdentitiesPath

dbIdentitiesPath: readonly (string | Buffer)[] = ...

Identity information GestaltGraph/identities/{GestaltKey} -> {json(GestaltIdentityInfo)}

`Readonly` dbLinksPath

dbLinksPath: readonly (string | Buffer)[] = ...

Gestalt links. GestaltGraph/links/{GestaltLinkId} -> {json(GestaltLink)}

`Readonly` dbMatrixPath

dbMatrixPath: readonly (string | Buffer)[] = ...

Gestalt adjacency matrix represented as a collection vertex pairs. Each vertex can be GestaltNodeKey or GestaltIdentityKey. These are the allowable structures: GestaltGraph/matrix/{GestaltKey} -> null GestaltGraph/matrix/{GestaltKey}/{GestaltKey} -> {raw(GestaltLinkId)}

`Readonly` dbNodesPath

dbNodesPath: readonly (string | Buffer)[] = ...

Node information GestaltGraph/nodes/{GestaltKey} -> {json(GestaltNodeInfo)}

`Readonly` dbPath

dbPath: readonly (string | Buffer)[] = ...

`Protected` generateGestaltLinkId

generateGestaltLinkId: (() => GestaltLinkId)

Type declaration

- (): GestaltLinkId
- Returns GestaltLinkId

`Protected` logger

logger: Logger

`Protected` nodeClaimIdOldestPath

nodeClaimIdOldestPath: readonly (string | Buffer)[] = ...

`Protected` vertexProcessedTimeOrderPath

vertexProcessedTimeOrderPath: readonly (string | Buffer)[] = ...

Last processed collection GestaltGraph/vertexProcessedTimeOrder/{number}/{GestaltIdEncoded} -> gestaltIdEncoded

`Protected` vertexProcessedTimePath

vertexProcessedTimePath: readonly (string | Buffer)[] = ...

Last processed collection GestaltGraph/VertexProcessedTime/{GestaltIdEncoded} -> number

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from createDestroyStartStop.CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.destroy
- Defined in src/gestalts/GestaltGraph.ts:153

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

getClaimIdNewest

getClaimIdNewest(nodeId, tran?): Promise<undefined | ClaimId>
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<undefined | ClaimId>
- Defined in src/gestalts/GestaltGraph.ts:532

getGestalt

getGestalt(gestaltId, tran?): Promise<undefined | Gestalt>
Parameters
- gestaltId: GestaltId
- Optional tran: DBTransaction
Returns Promise<undefined | Gestalt>
- Defined in src/gestalts/GestaltGraph.ts:1270

getGestaltActions

getGestaltActions(gestaltId, tran?): Promise<Partial<Record<"notify" | "scan" | "claim", null>>>
Parameters
- gestaltId: GestaltId
- Optional tran: DBTransaction
Returns Promise<Partial<Record<"notify" | "scan" | "claim", null>>>
- Defined in src/gestalts/GestaltGraph.ts:1111

getGestaltByIdentity

getGestaltByIdentity(providerIdentityId, tran?): Promise<undefined | Gestalt>
Parameters
- providerIdentityId: ProviderIdentityId
- Optional tran: DBTransaction
Returns Promise<undefined | Gestalt>
- Defined in src/gestalts/GestaltGraph.ts:1301

`Protected` getGestaltByKey

getGestaltByKey(gestaltKey, visited?, tran): Promise<undefined | Gestalt>
Gets a gestalt using BFS. During execution thevisited set indicates the vertexes that have been queued. This BFS algorithm has to 2 stages:
1. processing the vertex information.
2. processing the vertex links by iterating the vertex neighbours. When processing vertex information we need to avoid queued duplicate vertexes. When processing vertex links we need to avoid already processed links. When finished, the visited set indicates the vertexes that have been processed.
Parameters
- gestaltKey: GestaltKey
- visited: Set<string> = ...
- tran: DBTransaction
Returns Promise<undefined | Gestalt>
- Defined in src/gestalts/GestaltGraph.ts:1493

getGestaltByNode

getGestaltByNode(nodeId, tran?): Promise<undefined | Gestalt>
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<undefined | Gestalt>
- Defined in src/gestalts/GestaltGraph.ts:1285

getGestalts

getGestalts(tran?): AsyncGenerator<Gestalt, any, unknown>
Parameters
- Optional tran: DBTransaction
Returns AsyncGenerator<Gestalt, any, unknown>
- Defined in src/gestalts/GestaltGraph.ts:1237

getIdentity

getIdentity(providerIdentityId, tran?): Promise<undefined | GestaltIdentityInfo>
Parameters
- providerIdentityId: ProviderIdentityId
- Optional tran: DBTransaction
Returns Promise<undefined | GestaltIdentityInfo>
- Defined in src/gestalts/GestaltGraph.ts:1339

`Protected` getIdentityLinkedNodeId

getIdentityLinkedNodeId(providerIdentityId, tran): Promise<undefined | NodeId>
Parameters
- providerIdentityId: ProviderIdentityId
- tran: DBTransaction
Returns Promise<undefined | NodeId>
- Defined in src/gestalts/GestaltGraph.ts:1580

getLink

getLink(gestaltId1, gestaltId2, tran?): Promise<undefined | ["node", GestaltLinkNode]>
Parameters
- gestaltId1: ["node", NodeId]
- gestaltId2: ["node", NodeId]
- Optional tran: DBTransaction
Returns Promise<undefined | ["node", GestaltLinkNode]>
- Defined in src/gestalts/GestaltGraph.ts:1414
getLink(gestaltId1, gestaltId2, tran?): Promise<undefined | ["identity", GestaltLinkIdentity]>
Parameters
- gestaltId1: ["identity", ProviderIdentityId]
- gestaltId2: ["node", NodeId]
- Optional tran: DBTransaction
Returns Promise<undefined | ["identity", GestaltLinkIdentity]>
- Defined in src/gestalts/GestaltGraph.ts:1419
getLink(gestaltId1, gestaltId2, tran?): Promise<undefined | ["identity", GestaltLinkIdentity]>
Parameters
- gestaltId1: ["node", NodeId]
- gestaltId2: ["identity", ProviderIdentityId]
- Optional tran: DBTransaction
Returns Promise<undefined | ["identity", GestaltLinkIdentity]>
- Defined in src/gestalts/GestaltGraph.ts:1424

getLinkById

getLinkById(linkId, tran?): Promise<undefined | GestaltLink>
Parameters
- linkId: GestaltLinkId
- Optional tran: DBTransaction
Returns Promise<undefined | GestaltLink>
- Defined in src/gestalts/GestaltGraph.ts:1399

getLinks

getLinks(gestaltId, tran?): AsyncGenerator<[GestaltId, GestaltLink], any, unknown>
Parameters
- gestaltId: GestaltId
- Optional tran: DBTransaction
Returns AsyncGenerator<[GestaltId, GestaltLink], any, unknown>
- Defined in src/gestalts/GestaltGraph.ts:1456

getNode

getNode(nodeId, tran?): Promise<undefined | GestaltNodeInfo>
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<undefined | GestaltNodeInfo>
- Defined in src/gestalts/GestaltGraph.ts:1320

getVertex

getVertex(gestaltId, tran?): Promise<undefined | ["node", GestaltNodeInfo]>
Parameters
- gestaltId: ["node", NodeId]
- Optional tran: DBTransaction
Returns Promise<undefined | ["node", GestaltNodeInfo]>
- Defined in src/gestalts/GestaltGraph.ts:1363
getVertex(gestaltId, tran?): Promise<undefined | ["identity", GestaltIdentityInfo]>
Parameters
- gestaltId: ["identity", ProviderIdentityId]
- Optional tran: DBTransaction
Returns Promise<undefined | ["identity", GestaltIdentityInfo]>
- Defined in src/gestalts/GestaltGraph.ts:1367
getVertex(gestaltId, tran?): Promise<undefined | GestaltInfo>
Parameters
- gestaltId: GestaltId
- Optional tran: DBTransaction
Returns Promise<undefined | GestaltInfo>
- Defined in src/gestalts/GestaltGraph.ts:1371

getVertexProcessedTime

getVertexProcessedTime(vertex, tran?): Promise<undefined | number>
Gets the last processed time for a vertex
Parameters
- vertex: GestaltId
- Optional tran: DBTransaction
Returns Promise<undefined | number>
- Defined in src/gestalts/GestaltGraph.ts:424

getVertexProcessedTimes

getVertexProcessedTimes(__namedParameters?, tran?): AsyncGenerator<[GestaltId, number], any, unknown>
Gets the last processed time for a vertex
Parameters
- __namedParameters: {
      limit?: number;
      order?: "asc" | "desc";
      seek?: number;
  } = {}
  - Optional limit?: number
  - Optional order?: "asc" | "desc"
  - Optional seek?: number
- Optional tran: DBTransaction
Returns AsyncGenerator<[GestaltId, number], any, unknown>
- Defined in src/gestalts/GestaltGraph.ts:447

linkNodeAndIdentity

linkNodeAndIdentity(nodeInfo, identityInfo, linkIdentity, tran?): Promise<GestaltLinkId>
Parameters
- nodeInfo: GestaltNodeInfo
- identityInfo: GestaltIdentityInfo
- linkIdentity: Omit<GestaltLinkIdentity, "id">
- Optional tran: DBTransaction
Returns Promise<GestaltLinkId>
- Defined in src/gestalts/GestaltGraph.ts:708

linkNodeAndNode

linkNodeAndNode(nodeInfo1, nodeInfo2, linkNode, tran?): Promise<GestaltLinkId>
This checks if the link node has matching issuer and subject. It does not however verify the signatures. Verifying signatures should be done before linking the nodes in the GG
Parameters
- nodeInfo1: GestaltNodeInfo
- nodeInfo2: GestaltNodeInfo
- linkNode: Omit<GestaltLinkNode, "id">
- Optional tran: DBTransaction
Returns Promise<GestaltLinkId>
- Defined in src/gestalts/GestaltGraph.ts:560

linkVertexAndVertex

linkVertexAndVertex(gestaltInfo1, gestaltInfo2, link, tran?): Promise<GestaltLinkId>
Parameters
- gestaltInfo1: ["node", GestaltNodeInfo]
- gestaltInfo2: ["node", GestaltNodeInfo]
- link: ["node", Omit<GestaltLinkNode, "id">]
- Optional tran: DBTransaction
Returns Promise<GestaltLinkId>
- Defined in src/gestalts/GestaltGraph.ts:855
linkVertexAndVertex(gestaltInfo1, gestaltInfo2, link, tran?): Promise<GestaltLinkId>
Parameters
- gestaltInfo1: ["node", GestaltNodeInfo]
- gestaltInfo2: ["identity", GestaltIdentityInfo]
- link: ["identity", Omit<GestaltLinkIdentity, "id">]
- Optional tran: DBTransaction
Returns Promise<GestaltLinkId>
- Defined in src/gestalts/GestaltGraph.ts:861
linkVertexAndVertex(gestaltInfo1, gestaltInfo2, link, tran?): Promise<GestaltLinkId>
Parameters
- gestaltInfo1: ["identity", GestaltIdentityInfo]
- gestaltInfo2: ["node", GestaltNodeInfo]
- link: ["identity", Omit<GestaltLinkIdentity, "id">]
- Optional tran: DBTransaction
Returns Promise<GestaltLinkId>
- Defined in src/gestalts/GestaltGraph.ts:867

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

setClaimIdNewest

setClaimIdNewest(nodeId, claimId, tran?): Promise<void>
Updates the newest ClaimId for a node if it's newer than the current id stored
Parameters
- nodeId: NodeId
- claimId: ClaimId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:498

setGestaltAction

setGestaltAction(gestaltId, action, tran?): Promise<void>
Parameters
- gestaltId: GestaltId
- action: "notify" | "scan" | "claim"
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:1152

setIdentity

setIdentity(identityInfo, tran?): Promise<["identity", ProviderIdentityId]>
Parameters
- identityInfo: GestaltIdentityInfo
- Optional tran: DBTransaction
Returns Promise<["identity", ProviderIdentityId]>
- Defined in src/gestalts/GestaltGraph.ts:202

setNode

setNode(nodeInfo, tran?): Promise<["node", NodeId]>
Sets a node in the graph Can be used to update an existing node If this is a new node, it will set a new node pointer to a new gestalt permission in the acl
Parameters
- nodeInfo: GestaltNodeInfo
- Optional tran: DBTransaction
Returns Promise<["node", NodeId]>
- Defined in src/gestalts/GestaltGraph.ts:167

setVertex

setVertex(gestaltInfo, tran?): Promise<GestaltId>
Parameters
- gestaltInfo: GestaltInfo
- Optional tran: DBTransaction
Returns Promise<GestaltId>
- Defined in src/gestalts/GestaltGraph.ts:314

setVertexProcessedTime

setVertexProcessedTime(vertex, processedTime, tran?): Promise<void>
Updates the last processed time in the database for the given vertex
Parameters
- vertex: GestaltId
- processedTime: number
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:354

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.start
- Defined in src/gestalts/GestaltGraph.ts:139

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.stop
- Defined in src/gestalts/GestaltGraph.ts:148

unlinkNodeAndIdentity

unlinkNodeAndIdentity(nodeId, providerIdentityId, tran?): Promise<void>
Parameters
- nodeId: NodeId
- providerIdentityId: ProviderIdentityId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:982

unlinkNodeAndNode

unlinkNodeAndNode(nodeId1, nodeId2, tran?): Promise<void>
Parameters
- nodeId1: NodeId
- nodeId2: NodeId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:910

unlinkVertexAndVertex

unlinkVertexAndVertex(gestaltId1, gestaltId2, tran?): Promise<void>
Parameters
- gestaltId1: ["node", NodeId]
- gestaltId2: ["node", NodeId]
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:1065
unlinkVertexAndVertex(gestaltId1, gestaltId2, tran?): Promise<void>
Parameters
- gestaltId1: ["node", NodeId]
- gestaltId2: ["identity", ProviderIdentityId]
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:1070
unlinkVertexAndVertex(gestaltId1, gestaltId2, tran?): Promise<void>
Parameters
- gestaltId1: ["identity", ProviderIdentityId]
- gestaltId2: ["node", NodeId]
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:1075

unsetGestaltAction

unsetGestaltAction(gestaltId, action, tran?): Promise<void>
Parameters
- gestaltId: GestaltId
- action: "notify" | "scan" | "claim"
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:1193

unsetIdentity

unsetIdentity(providerIdentityId, tran?): Promise<void>
Parameters
- providerIdentityId: ProviderIdentityId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:270

unsetNode

unsetNode(nodeId, tran?): Promise<void>
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:237

unsetVertex

unsetVertex(gestaltId, tran?): Promise<void>
Parameters
- gestaltId: GestaltId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:333

unsetVertexProcessedTime

unsetVertexProcessedTime(vertex, tran?): Promise<void>
Removes the last processed time for a vertex
Parameters
- vertex: GestaltId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/gestalts/GestaltGraph.ts:390

`Static` createGestaltGraph

createGestaltGraph(__namedParameters): Promise<GestaltGraph>
Parameters
- __namedParameters: {
      acl: ACL;
      db: DB;
      fresh?: boolean;
      logger?: Logger;
  }
  - acl: ACL
  - db: DB
  - Optional fresh?: boolean
  - Optional logger?: Logger
Returns Promise<GestaltGraph>
- Defined in src/gestalts/GestaltGraph.ts:45

Class GestaltGraph

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { acl: ACL; db: DB; logger: Logger; }

acl: ACL

db: DB

logger: Logger

Returns GestaltGraph

Properties

Readonly [initLock]

Protected acl

Protected db

Readonly dbIdentitiesPath

Readonly dbLinksPath

Readonly dbMatrixPath

Readonly dbNodesPath

Readonly dbPath

Protected generateGestaltLinkId

Type declaration

Returns GestaltLinkId

Protected logger

Protected nodeClaimIdOldestPath

Protected vertexProcessedTimeOrderPath

Protected vertexProcessedTimePath

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

getClaimIdNewest

Parameters

nodeId: NodeId

Optional tran: DBTransaction

Returns Promise<undefined | ClaimId>

getGestalt

Parameters

gestaltId: GestaltId

Optional tran: DBTransaction

Returns Promise<undefined | Gestalt>

getGestaltActions

Parameters

gestaltId: GestaltId

Optional tran: DBTransaction

Returns Promise<Partial<Record<"notify" | "scan" | "claim", null>>>

getGestaltByIdentity

__namedParameters: {
acl: ACL;
db: DB;
logger: Logger;
}

`Readonly` [initLock]

`Protected` acl

`Protected` db

`Readonly` dbIdentitiesPath

`Readonly` dbLinksPath

`Readonly` dbMatrixPath

`Readonly` dbNodesPath

`Readonly` dbPath

`Protected` generateGestaltLinkId

`Protected` logger

`Protected` nodeClaimIdOldestPath

`Protected` vertexProcessedTimeOrderPath

`Protected` vertexProcessedTimePath

`Optional` options: boolean | AddEventListenerOptions

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Protected` getGestaltByKey

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Protected` getIdentityLinkedNodeId

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction