@erd-studio/renderer 0.1.3 → 0.3.0

package/dist/types/types/graph.d.ts

@@ -2,15 +2,15 @@
  * Types for React Flow graph nodes and edges.
  *
  * These types define the data payloads for custom React Flow node and edge
- * components. The graph transformer converts DisplayDomain data into
+ * components. The graph transformer converts DisplaySubjectArea data into
  * these shapes.
  */
 import type { Node, Edge } from '@xyflow/react';
-import type { AnnotationColor, Cardinality, ColumnPair, DbtKeyHint, Layer, Meta, ModelLoadError, ModelRole, Stage } from '@erd-studio/core';
+import type { AnnotationColor, Cardinality, ColumnPair, DbtKeyHint, Layer, Meta, TableLoadError, TableLoadWarning, TableRole, Stage } from '@erd-studio/core';
 import type { LayerConfig } from '@erd-studio/core';
-import type { ModelDiscrepancy } from '@erd-studio/core';
+import type { TableDiscrepancy } from '@erd-studio/core';
 import type { PhysicalProvenance } from '@erd-studio/core';
-/** Column data enriched with PK/FK/NK indicators for display in ModelNode. */
+/** Column data enriched with PK/FK/NK indicators for display in TableNode. */
 export interface ColumnDisplay {
     name: string;
     dataType: string;
@@ -30,14 +30,14 @@ export interface ColumnDisplay {
     /** What dbt's tests say about the column (editable logical canvas only) — one line of its hover text. */
     dbtKey?: DbtKeyHint;
 }
-/** Data payload for a ModelNode React Flow node. */
-export type ModelNodeData = {
+/** Data payload for a TableNode React Flow node. */
+export type TableNodeData = {
     /** Model name (unique within a domain). */
     modelName: string;
     /**
      * Header label when it differs from `modelName`: the model's table name
      * (`alias`), qualified by schema when another model on the canvas would read
-     * the same. See `computeModelLabels`.
+     * the same. See `computeTableLabels`.
      */
     label?: string;
     /** The active design stage. */
@@ -65,7 +65,7 @@ export type ModelNodeData = {
     /** Grain statement — "One row per ___". Shown as subtitle on node. */
     grain?: string;
     /** Model's role in the data warehouse architecture. Shown as badge on node. */
-    modelRole?: ModelRole;
+    modelRole?: TableRole;
     /** Structured metadata (`meta:`) — shown in the name's hover tip. Absent when empty. */
     meta?: Meta;
     /** Whether this stage is read-only (physical). */
@@ -93,11 +93,16 @@ export type ModelNodeData = {
      * The model's file exists but could not be read (logical stage only): the
      * node shows the error and an "Open file" button instead of "No columns".
      */
-    loadError?: ModelLoadError;
+    loadError?: TableLoadError;
+    /**
+     * The model's file was read but needs fixing (logical stage only): a key
+     * written twice, whose last value is shown (#164). Absent from an older core.
+     */
+    loadWarning?: TableLoadWarning;
     /** Whether this model is in stub display mode (PK/NK columns only). */
     isStub: boolean;
     /** Per-model discrepancy data when a cross-stage comparison report is active. */
-    discrepancy?: ModelDiscrepancy;
+    discrepancy?: TableDiscrepancy;
     /** The stage currently being viewed (set when discrepancy overlay is active). */
     discrepancySourceStage?: Stage;
     /** The stage being compared against (set when discrepancy overlay is active). */
@@ -106,14 +111,14 @@ export type ModelNodeData = {
      * Index signature required by React Flow's Node generic.
      *
      * It also means an unknown or misspelled key type-checks, and a field written
-     * here but never destructured in ModelNode ships as dead payload — which is
+     * here but never destructured in TableNode ships as dead payload — which is
      * exactly how `hasRationale` and `modelRole` gained matching dead CSS. Add a
      * field here only together with the code that reads it.
      */
     [key: string]: unknown;
 };
 /** Typed React Flow node for a semantic model. */
-export type ModelFlowNode = Node<ModelNodeData, 'model'>;
+export type TableFlowNode = Node<TableNodeData, 'model'>;
 /** Data payload for an FkEdge React Flow edge. */
 export type FkEdgeData = {
     fromModel: string;
@@ -130,6 +135,11 @@ export type FkEdgeData = {
     pairs?: ColumnPair[];
     /** The composite's `compositeKey` name, alongside `pairs`. */
     compositeKey?: string;
+    /**
+     * The keys contradict its direction (`DisplayRelationship.keysContradict`,
+     * #163): drawn with a ⚠ and Turn round, except for viewers.
+     */
+    keysContradict?: true;
     /** Stage of the owning domain canvas — drives CSS colour class. */
     stage?: Stage;
     /** Discrepancy status for ghost/extra/mismatch edges. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erd-studio/renderer",
-  "version": "0.1.3",
+  "version": "0.3.0",
   "description": "ERD Studio's React Flow canvas: the entity-relationship diagram renderer shared by the VS Code extension, with a read-only viewer mode.",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {
@@ -36,6 +36,7 @@
   },
   "files": [
     "dist",
+    "CHANGELOG.md",
     "LICENSE",
     "README.md"
   ],
@@ -46,7 +47,7 @@
     "prepack": "npm run build"
   },
   "dependencies": {
-    "@erd-studio/core": "0.1.3",
+    "@erd-studio/core": "0.3.0",
     "zustand": "^5.0.0"
   },
   "peerDependencies": {