Class GestaltGraph

Hierarchy

CreateDestroyStartStop
- GestaltGraph

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.constructor
- Defined in src/gestalts/GestaltGraph.ts:111

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

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from 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.[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.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from 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.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from 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.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from 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.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

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

dispatchEvent

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

getGestalt

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

getGestaltActions

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

getGestaltByIdentity

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

`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:1201

getGestaltByNode

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

getGestalts

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

getIdentity

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

`Protected` getIdentityLinkedNodeId

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

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:1124
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:1129
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:1134

getLinkById

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

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:1164

getNode

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

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:1075
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:1079
getVertex(gestaltId, tran?): Promise<undefined | GestaltInfo>
Parameters
- gestaltId: GestaltId
- Optional tran: DBTransaction
Returns Promise<undefined | GestaltInfo>
- Defined in src/gestalts/GestaltGraph.ts:1083

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:462

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:320

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:603
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:609
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:615

removeEventListener

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

setGestaltAction

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

setIdentity

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

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:145

setVertex

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

start

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

stop

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

unlinkNodeAndIdentity

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

unlinkNodeAndNode

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

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:797
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:802
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:807

unsetGestaltAction

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

unsetIdentity

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

unsetNode

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

unsetVertex

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

`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:46

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

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

getGestalt

Parameters

gestaltId: GestaltId

Optional tran: DBTransaction

Returns Promise<undefined | Gestalt>

getGestaltActions

Parameters

gestaltId: GestaltId

Optional tran: DBTransaction

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

getGestaltByIdentity

Parameters

providerIdentityId: ProviderIdentityId

Optional tran: DBTransaction

Returns Promise<undefined | Gestalt>

Protected getGestaltByKey

Parameters

gestaltKey: GestaltKey

visited: Set<string> = ...

__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

`Optional` options: boolean | AddEventListenerOptions

`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

`Optional` tran: DBTransaction