@memberjunction/record-graph 0.0.1-seed.1 → 6.2.0-edge.3

package/dist/types.d.ts

@@ -0,0 +1,148 @@
+import type { CompositeKey, EntityInfo, EntityRelationshipInfo } from '@memberjunction/core';
+/**
+ * Kind of edge connecting two record nodes in the dependency graph.
+ */
+export type EdgeKind = 'IsASubtype' | 'Collection' | 'Embedded' | 'Relationship' | 'InboundFK' | 'ForwardFK' | 'SoftLink' | 'Hierarchy' | 'SelfPointer';
+/**
+ * Backward-compatibility alias for clone plan consumers.
+ */
+export type CloneEdgeKind = EdgeKind;
+/**
+ * Policy decision returned by the EdgePolicy callback.
+ * - 'Deep': traverse and recurse children.
+ * - 'Reference': record the target node / edge but do not recurse into its reverse children.
+ * - 'Skip': do not traverse or include the target node.
+ */
+export type EdgePolicyDecision = 'Deep' | 'Reference' | 'Skip';
+/**
+ * Information about a candidate edge presented to an EdgePolicy callback before traversal.
+ */
+export interface GraphEdgeCandidate {
+    Kind: EdgeKind;
+    SourceEntityName: string;
+    SourceKey: CompositeKey;
+    SourceRecordData: Record<string, unknown>;
+    TargetEntityName: string;
+    TargetKey?: CompositeKey;
+    JoinField: string;
+    Relationship?: EntityRelationshipInfo | null;
+    CollectionName?: string;
+    IsSoftLink?: boolean;
+    EntityIDFieldName?: string;
+    Depth: number;
+    /**
+     * For `Hierarchy` edges: `Down` to a child row (its parent FK points at the source), `Up` to the
+     * source's own parent (the source's parent FK). A subtree walk goes down; up is the parent it hangs from.
+     */
+    HierarchyDirection?: 'Up' | 'Down';
+}
+/**
+ * A resolved edge in the record graph.
+ */
+export interface GraphEdge {
+    Kind: EdgeKind;
+    FromKey: string;
+    ToKey: string;
+    SourceEntityName: string;
+    TargetEntityName: string;
+    JoinField: string;
+    Relationship?: EntityRelationshipInfo | null;
+    CollectionName?: string;
+    IsSoftLink?: boolean;
+    EntityIDFieldName?: string;
+}
+/**
+ * A node in the record dependency graph representing a single entity record.
+ */
+export interface DependencyNode {
+    /** Entity name */
+    EntityName: string;
+    /** Entity metadata */
+    EntityInfo: EntityInfo;
+    /** The record's primary key */
+    RecordKey: CompositeKey;
+    /** The record's primary key as a concatenated string */
+    RecordID: string;
+    /** Current field values of the record */
+    RecordData: Record<string, unknown>;
+    /** Relationship from parent to this node (null for root) */
+    Relationship: EntityRelationshipInfo | null;
+    /** Child/dependent record nodes */
+    Children: DependencyNode[];
+    /** Depth in the graph (0 = root) */
+    Depth: number;
+    /** The edge that led to the discovery of this node (null for root) */
+    DiscoveringEdge?: GraphEdge | null;
+    /** Whether this node is an IS-A subtype row */
+    IsSubtypeRow?: boolean;
+}
+/**
+ * Alias for DependencyNode in generalized graph contexts.
+ */
+export type GraphNode = DependencyNode;
+/**
+ * A full record dependency graph model containing root, flattened nodes, edges, and optional key map.
+ */
+export interface RecordGraph {
+    Root: DependencyNode;
+    Nodes: DependencyNode[];
+    Edges: GraphEdge[];
+    KeyMap?: Record<string, string>;
+}
+/**
+ * Mapping between source record keys and target/new record keys.
+ */
+export type KeyMap = Record<string, string>;
+/**
+ * Options controlling graph traversal.
+ */
+export interface WalkOptions {
+    /** Maximum recursion depth (default: 10 for Version History, 3 for cloning) */
+    MaxDepth?: number;
+    /** Only include these entities */
+    EntityFilter?: string[];
+    /** Skip these entities */
+    ExcludeEntities?: string[];
+    /** Include soft-deleted records (default: false) */
+    IncludeDeleted?: boolean;
+    /**
+     * Whether to require entities to have TrackRecordChanges enabled.
+     * Version History passes true (or defaults to true); cloning passes false.
+     * Default: true
+     */
+    RequireTrackRecordChanges?: boolean;
+    /** Follow inbound EntityID/RecordID soft links as reverse edges. Default false. */
+    IncludeSoftLinks?: boolean;
+    /** Add IS-A subtype rows of every discovered record as nodes (via FindISAChildEntities). Default false. */
+    IncludeSubtypes?: boolean;
+    /** Allow same-entity recursion on fields whose Configuration.Hierarchy.IsHierarchy is true, up to HierarchyMaxDepth. Default false. */
+    FollowHierarchies?: boolean;
+    /** List (without loading) inbound FK relationships that are not curated EntityRelationship rows, so a caller can show "available" edges. Default false. */
+    ListNonCuratedInbound?: boolean;
+    /** Called per candidate edge before traversal; returning Skip prunes the walk, Reference records the target without recursing, Deep recurses. */
+    EdgePolicy?: (edge: GraphEdgeCandidate) => EdgePolicyDecision;
+    /**
+     * Called when the rows of an edge the walk follows can't be loaded (no read permission, a
+     * failed query). The walk goes on without them, so a caller that must not act on a partial
+     * graph (cloning) reports it. Default: the failure is only logged.
+     */
+    OnLoadFailure?: (failure: GraphLoadFailure) => void;
+}
+/** An edge whose rows could not be loaded during a walk. */
+export interface GraphLoadFailure {
+    Edge: GraphEdgeCandidate;
+    /** What the edge policy decided before the load (Deep when there is no policy). */
+    Decision: EdgePolicyDecision;
+    Message: string;
+}
+/**
+ * Accumulator for graph traversal statistics.
+ */
+export interface WalkStats {
+    EntityCounts: Map<string, number>;
+    TotalRecords: number;
+    AncestorSkips: number;
+    VisitedSkips: number;
+    ForwardOnlySuppressions: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAE7F;;GAEG;AACH,MAAM,MAAM,QAAQ,GACd,YAAY,GACZ,YAAY,GACZ,UAAU,GACV,cAAc,GACd,WAAW,GACX,WAAW,GACX,UAAU,GACV,WAAW,GACX,aAAa,CAAC;AAEpB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC;AAErC;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,QAAQ,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,YAAY,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC7C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC7C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,UAAU,EAAE,UAAU,CAAC;IACvB,+BAA+B;IAC/B,SAAS,EAAE,YAAY,CAAC;IACxB,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,4DAA4D;IAC5D,YAAY,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC5C,mCAAmC;IACnC,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,eAAe,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACnC,+CAA+C;IAC/C,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,0BAA0B;IAC1B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,oDAAoD;IACpD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,mFAAmF;IACnF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,2GAA2G;IAC3G,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,uIAAuI;IACvI,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,2JAA2J;IAC3J,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,iJAAiJ;IACjJ,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,kBAAkB,CAAC;IAC9D;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;CACvD;AAED,4DAA4D;AAC5D,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,kBAAkB,CAAC;IACzB,mFAAmF;IACnF,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,EAAE,MAAM,CAAC;CACnC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,10 +1,30 @@
 {
   "name": "@memberjunction/record-graph",
-  "version": "0.0.1-seed.1",
-  "description": "Trusted-publishing seed. Proves OIDC is configured; contains no code.",
-  "license": "ISC",
+  "type": "module",
+  "version": "6.2.0-edge.3",
+  "description": "MemberJunction: Generalized record dependency graph walker, relationship collection resolver, topological sort, link value encoding, and graph models. Shared by Version History, Record Cloning, and Metadata Sync.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "author": "MemberJunction.com",
+  "license": "BUSL-1.1",
+  "dependencies": {
+    "@memberjunction/core": "6.2.0-edge.3",
+    "@memberjunction/global": "6.2.0-edge.3"
+  },
+  "devDependencies": {
+    "@types/node": "24.10.11",
+    "typescript": "^5.9.3"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/MemberJunction/MJ.git"
+    "url": "https://github.com/MemberJunction/MJ"
+  },
+  "scripts": {
+    "build": "tsc && tsc-alias -f",
+    "test": "vitest run",
+    "test:watch": "vitest"
   }
-}
+}