@rokkit/graph 1.8.0 → 1.8.1

package/dist/types.d.ts

@@ -12,7 +12,11 @@ export type GraphRow = {
  * (a view reading a table, a procedure calling a function). Layouts branch on
  * this rather than on any schema-specific notion.
  */
-export type EdgeKind = 'reference' | 'dependency';
+/**
+ * `reference` (a foreign key) and `dependency` come from the data. `containment` is drawn by a
+ * tree layout (`polymetric`) between a container and what it holds — the tree's own links.
+ */
+export type EdgeKind = 'reference' | 'dependency' | 'containment';
 export type GraphNode = {
     /** Stable key. `${group}.${label}` when a group is present, else `label`. */
     id: string;
@@ -54,8 +58,25 @@ export type GraphNode = {
      *
      * Accepts a delimited STRING too (`'dbd/core/lexer/parse'`), since that is how a file path
      * arrives. See `GraphFields.pathDelimiter`.
+     *
+     * A host that gives containment as `parent` ids instead (#168) need not convert: a node with
+     * no path but a parent chain gets one, as ids (`GraphFields.parent`). The path is still what
+     * the model holds — the chain is read once, at normalisation.
      */
     path?: string[];
+    /**
+     * The node ids this node STANDS FOR — a group, typically one strongly-connected component
+     * the host condensed (#166). rokkit computes no SCCs: it draws what the host grouped. While
+     * the group is collapsed its members are hidden and their edges reroute to it.
+     */
+    members?: string[];
+    /** Whether a group starts collapsed. A node with `members` and no flag is collapsed. */
+    collapsed?: boolean;
+    /**
+     * The layer the HOST assigned (#167) — 0 at the top, foundations at the bottom. rokkit
+     * computes no depth; the `layers` layout ranks by this.
+     */
+    layer?: number;
     rows: GraphRow[];
     note?: string;
     /** Source fields the map did not claim, passed through untouched. */
@@ -107,7 +128,27 @@ export type GraphEdge = {
     overlay?: boolean;
     /** A strength this edge carries — co-change count, call frequency. Drives stroke width. */
     weight?: number;
+    /**
+     * The cheapest link to cut to break a cycle — the edge with the fewest occurrences (#166).
+     * Naming it is the actionable output of a cycles view, so it is styleable on its own
+     * (`data-edge-weakest`).
+     */
+    weakest?: boolean;
+    /**
+     * Coupling nothing in the code explains — a pair that changes together with no import
+     * between them (#169). The host computes it; the graph only styles it (`data-edge-hidden`).
+     */
+    hidden?: boolean;
+    /** How many model edges this one stands for, when it aggregates a collapsed group's edges. */
+    count?: number;
+    /**
+     * How the edge sits against the layering (#167): `down` one layer (conformant), `skip` more
+     * than one down (legal, worth seeing), `up` climbing (the violation), `level` within a layer.
+     * The host says; when it does not, the `layers` layout derives it from the layers.
+     */
+    conformance?: Conformance;
 };
+export type Conformance = 'down' | 'skip' | 'up' | 'level';
 export type GraphModel = {
     nodes: GraphNode[];
     /** Structural edges — the ones layouts, neighbours and relationships see. */
@@ -169,6 +210,19 @@ export type GraphProps = {
     label?: string;
     /** Fires on selection AND on clear, where it receives `null`. */
     onselect?: (id: string | null) => void;
+    /**
+     * The containment subtree drawn as the whole canvas (`world`, `sunburst`, `structure`).
+     * Bindable: drilling moves it. `[]` is the root.
+     */
+    focusPath?: string[];
+    /** The reader drilled into a box — see `GraphStateConfig.ondrill`. */
+    ondrill?: (path: string[], node: GraphNode | null) => void | Promise<void>;
+    /** The reader drilled out — see `GraphStateConfig.ondrillup`. */
+    ondrillup?: (path: string[]) => void | Promise<void>;
+    /** The reader expanded a group — see `GraphStateConfig.onexpand`. */
+    onexpand?: (id: string, node: GraphNode) => void;
+    /** The reader collapsed a group — see `GraphStateConfig.oncollapse`. */
+    oncollapse?: (id: string, node: GraphNode) => void;
     /** Icon class per node kind and row badge, merged over the built-in map. */
     icons?: Record<string, string>;
     class?: string;
@@ -225,6 +279,23 @@ export type GraphFields = {
     relation?: string;
     /** Path to a truthy flag marking an overlay edge — see `GraphEdge.overlay`. */
     overlay?: string;
+    /** Path to a group's member ids — see `GraphNode.members`. */
+    members?: string;
+    /** Path to a group's starting state — see `GraphNode.collapsed`. */
+    collapsed?: string;
+    /** Path to a truthy flag marking the weakest edge of a cycle — see `GraphEdge.weakest`. */
+    weakest?: string;
+    /** Path to a truthy flag marking hidden coupling — see `GraphEdge.hidden`. */
+    hidden?: string;
+    /** Path to a node's host-assigned layer — see `GraphNode.layer`. */
+    layer?: string;
+    /**
+     * Path to a node's PARENT id — containment as a parent chain rather than a `path` (#168).
+     * Used only for a node with no `path`; it becomes one, as ids.
+     */
+    parent?: string;
+    /** Path to an edge's conformance to the layering — see `GraphEdge.conformance`. */
+    conformance?: string;
     /** Path to an edge's strength — see `GraphEdge.weight`. */
     edgeWeight?: string;
     cardinality?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokkit/graph",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "Node-link diagram components — pluggable layouts, ER/schema views",
   "repository": {
     "type": "git",
@@ -46,7 +46,8 @@
     "check:types": "tsc --noEmit"
   },
   "dependencies": {
-    "@rokkit/core": "1.8.0"
+    "@rokkit/core": "1.8.0",
+    "@rokkit/states": "1.8.0"
   },
   "peerDependencies": {
     "@rokkit/ui": "1.8.0",