Class DependencyGraphWalker

Walks a record's relationship graph to discover all dependent and referenced records.

Traversal rules:

Reverse walk: follows curated One-To-Many relationships (where child points to parent). Recurses with 'full' mode (both reverse + forward).
Forward walk: follows foreign keys on the parent (where parent points to another entity). Recurses with 'forward-only' mode — targets do NOT discover their own reverse children, preventing graph explosion from shared/hub entities.
Subtypes: follows IS-A inheritance if IncludeSubtypes is true.
Hierarchies: follows self-referencing hierarchy FKs if FollowHierarchies is true.
Soft links: follows inbound polymorphic EntityID/RecordID links if IncludeSoftLinks is true.
Non-curated inbound FKs: discovers non-curated inbound FKs if ListNonCuratedInbound is true.
EdgePolicy: callers can supply an EdgePolicy callback to dictate Deep / Reference / Skip per edge.
Cycle prevention: uses ancestorStack (entity types) to prevent backtracking and a global visited set (records).

Index

Constructors

Accessors

Methods

FlattenTopological WalkDependents

Constructors

constructor

new DependencyGraphWalker(provider?: IMetadataProvider): DependencyGraphWalker
Parameters
- Optionalprovider: IMetadataProvider
Returns DependencyGraphWalker
- Defined in DependencyGraphWalker.ts:88

Accessors

`Protected`ProviderToUse

get ProviderToUse(): IExtendedMetadataProvider
Returns the active provider — explicit override if set, otherwise the global default.

Returns IExtendedMetadataProvider
- Defined in DependencyGraphWalker.ts:93

Methods

FlattenTopological

FlattenTopological(root: DependencyNode): DependencyNode[]
Flatten a dependency tree into a topologically sorted list. Parents appear before their children, ensuring safe restore or clone execution ordering.
Parameters
- root: DependencyNode
Returns DependencyNode[]
- Defined in DependencyGraphWalker.ts:165

WalkDependents

WalkDependents(
    entityName: string,
    recordKey: CompositeKey,
    options: WalkOptions,
    contextUser: UserInfo,
): Promise<DependencyNode>
Walk from a root record through its relationships, building a tree of all records that should be included in a version label or clone plan.
Parameters
- entityName: string
  The starting entity name
- recordKey: CompositeKey
  The starting record's primary key
- options: WalkOptions
  Controls depth, filtering, policies, etc.
- contextUser: UserInfo
  Server-side user context
Returns Promise<DependencyNode>
The root DependencyNode with all descendants populated
- Defined in DependencyGraphWalker.ts:111