fix(diagram): display relationship cardinalities

This commit is contained in:
zipg authored and GitHub committed 2026-08-02 16:34:35 +08:00
1 parent 86c53479a1
commit fb7b2878fd
12 files changed
+316 -28

No files matched your search

@@ -14,7 +14,7 @@ import { DIAGRAM_SQL_TYPES, isSchemaAware as isSchemaAwareDatabase } from "@/lib
import { databaseOptionsForConnection } from "@/composables/useDatabaseOptions"; import { databaseOptionsForConnection } from "@/composables/useDatabaseOptions";
import { buildDiagramJoinSql, buildDiagramRelationships, filterDiagramTables, layoutDiagramTables, normalizeCustomDiagramRelationship, type CustomDiagramRelationship, type DiagramPosition, type DiagramRelationship, type DiagramTable } from "@/lib/diagram/erDiagram"; import { buildDiagramJoinSql, buildDiagramRelationships, filterDiagramTables, layoutDiagramTables, normalizeCustomDiagramRelationship, type CustomDiagramRelationship, type DiagramPosition, type DiagramRelationship, type DiagramTable } from "@/lib/diagram/erDiagram";
import { buildEngineeringDiagram } from "@/lib/diagram/engineeringDiagram"; import { buildEngineeringDiagram } from "@/lib/diagram/engineeringDiagram";
import { buildEngineeringDiagramSvg, buildTableDiagramSvg, diagramSvgFileName } from "@/lib/export/diagramSvgExport"; import { buildEngineeringDiagramSvg, buildTableDiagramSvg, diagramSvgFileName, type TableDiagramRelationshipLayout } from "@/lib/export/diagramSvgExport";
import { clampDiagramZoom, zoomFromGestureScale, zoomFromWheelDelta } from "@/lib/diagram/diagramZoom"; import { clampDiagramZoom, zoomFromGestureScale, zoomFromWheelDelta } from "@/lib/diagram/diagramZoom";
import { Copy, Download, KeyRound, Link2, Loader2, Maximize2, Network, Plus, RefreshCw, Search, Table2, Trash2, X, ZoomIn, ZoomOut } from "@lucide/vue"; import { Copy, Download, KeyRound, Link2, Loader2, Maximize2, Network, Plus, RefreshCw, Search, Table2, Trash2, X, ZoomIn, ZoomOut } from "@lucide/vue";
import { useToast } from "@/composables/useToast"; import { useToast } from "@/composables/useToast";
@@ -88,7 +88,7 @@ const relationshipDraft = ref({
sourceColumn: "", sourceColumn: "",
targetTable: "", targetTable: "",
targetColumn: "", targetColumn: "",
cardinality: "one-to-many" as "one-to-one" | "one-to-many" | "many-to-one", cardinality: "one-to-many" as "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many",
}); });
const sqlConnections = computed(() => store.connections.filter((connection) => DIAGRAM_SQL_TYPES.has(connection.db_type))); const sqlConnections = computed(() => store.connections.filter((connection) => DIAGRAM_SQL_TYPES.has(connection.db_type)));
@@ -253,6 +253,7 @@ function defaultRelationshipName(relationship: Omit<CustomDiagramRelationship, "
function relationshipCardinality(): Pick<CustomDiagramRelationship, "sourceCardinality" | "targetCardinality"> { function relationshipCardinality(): Pick<CustomDiagramRelationship, "sourceCardinality" | "targetCardinality"> {
if (relationshipDraft.value.cardinality === "one-to-one") return { sourceCardinality: "1", targetCardinality: "1" }; if (relationshipDraft.value.cardinality === "one-to-one") return { sourceCardinality: "1", targetCardinality: "1" };
if (relationshipDraft.value.cardinality === "many-to-one") return { sourceCardinality: "N", targetCardinality: "1" }; if (relationshipDraft.value.cardinality === "many-to-one") return { sourceCardinality: "N", targetCardinality: "1" };
if (relationshipDraft.value.cardinality === "many-to-many") return { sourceCardinality: "N", targetCardinality: "N" };
return { sourceCardinality: "1", targetCardinality: "N" }; return { sourceCardinality: "1", targetCardinality: "N" };
} }
@@ -423,10 +424,17 @@ function candidateRouteXs(source: TableRect, target: TableRect): number[] {
}); });
} }
function relationshipPath(relationship: DiagramRelationship): string { function relationshipLayout(relationship: DiagramRelationship): TableDiagramRelationshipLayout {
const source = getTableRect(relationship.sourceTable); const source = getTableRect(relationship.sourceTable);
const target = getTableRect(relationship.targetTable); const target = getTableRect(relationship.targetTable);
if (!source || !target) return ""; if (!source || !target) {
return {
path: "",
routePoints: [],
sourceCardinality: { x: 0, y: 0 },
targetCardinality: { x: 0, y: 0 },
};
}
const y1 = columnAnchorY(relationship.sourceTable, relationship.sourceColumn); const y1 = columnAnchorY(relationship.sourceTable, relationship.sourceColumn);
const y2 = columnAnchorY(relationship.targetTable, relationship.targetColumn); const y2 = columnAnchorY(relationship.targetTable, relationship.targetColumn);
@@ -444,9 +452,29 @@ function relationshipPath(relationship: DiagramRelationship): string {
const x1 = routeSideX(source, routeX, 2); const x1 = routeSideX(source, routeX, 2);
const x2 = routeSideX(target, routeX, 2); const x2 = routeSideX(target, routeX, 2);
return `M ${x1} ${y1} L ${routeX} ${y1} L ${routeX} ${y2} L ${x2} ${y2}`; const cardinalityOffset = 14;
const cardinalityLift = 10;
return {
path: `M ${x1} ${y1} L ${routeX} ${y1} L ${routeX} ${y2} L ${x2} ${y2}`,
routePoints: [
{ x: x1, y: y1 },
{ x: routeX, y: y1 },
{ x: routeX, y: y2 },
{ x: x2, y: y2 },
],
sourceCardinality: {
x: x1 + (routeX < source.x ? -cardinalityOffset : cardinalityOffset),
y: y1 - cardinalityLift,
},
targetCardinality: {
x: x2 + (routeX < target.x ? -cardinalityOffset : cardinalityOffset),
y: y2 - cardinalityLift,
},
};
} }
const tableRelationshipLayouts = computed<Record<string, TableDiagramRelationshipLayout>>(() => Object.fromEntries(visibleRelationships.value.map((relationship) => [relationship.id, relationshipLayout(relationship)])));
function engineeringEntityCenter(tableName: string): DiagramPosition { function engineeringEntityCenter(tableName: string): DiagramPosition {
const entity = engineeringDiagram.value.entities.find((item) => item.name === tableName); const entity = engineeringDiagram.value.entities.find((item) => item.name === tableName);
return entity ? { x: entity.x + entity.width / 2, y: entity.y + entity.height / 2 } : { x: 0, y: 0 }; return entity ? { x: entity.x + entity.width / 2, y: entity.y + entity.height / 2 } : { x: 0, y: 0 };
@@ -541,8 +569,12 @@ async function setSchema(value: string) {
async function loadTableDiagramData(tableName: string, querySchema: string): Promise<DiagramTable> { async function loadTableDiagramData(tableName: string, querySchema: string): Promise<DiagramTable> {
try { try {
const [columns, foreignKeys] = await Promise.all([api.getColumns(connectionId.value, database.value, querySchema, tableName), api.listForeignKeys(connectionId.value, database.value, querySchema, tableName).catch(() => [])]); const [columns, foreignKeys, indexes] = await Promise.all([
return { name: tableName, columns, foreignKeys }; api.getColumns(connectionId.value, database.value, querySchema, tableName),
api.listForeignKeys(connectionId.value, database.value, querySchema, tableName).catch(() => []),
api.listIndexes(connectionId.value, database.value, querySchema, tableName).catch(() => []),
]);
return { name: tableName, columns, foreignKeys, indexes };
} catch (e) { } catch (e) {
failedTableCount.value += 1; failedTableCount.value += 1;
console.warn(`[diagram] failed to load table metadata: ${tableName}`, e); console.warn(`[diagram] failed to load table metadata: ${tableName}`, e);
@@ -655,10 +687,6 @@ function resetZoomAndLayout() {
resetLayout(); resetLayout();
} }
function tableRelationshipPaths(): Record<string, string> {
return Object.fromEntries(visibleRelationships.value.map((relationship) => [relationship.id, relationshipPath(relationship)]));
}
function currentDiagramSvg(): string { function currentDiagramSvg(): string {
if (diagramMode.value === "engineering") { if (diagramMode.value === "engineering") {
return buildEngineeringDiagramSvg(engineeringDiagram.value); return buildEngineeringDiagramSvg(engineeringDiagram.value);
@@ -668,7 +696,7 @@ function currentDiagramSvg(): string {
tables: visibleTables.value, tables: visibleTables.value,
relationships: visibleRelationships.value, relationships: visibleRelationships.value,
positions: positions.value, positions: positions.value,
relationshipPaths: tableRelationshipPaths(), relationshipLayouts: tableRelationshipLayouts.value,
canvas: canvasSize.value, canvas: canvasSize.value,
cardWidth: CARD_WIDTH, cardWidth: CARD_WIDTH,
cardHeaderHeight: CARD_HEADER_HEIGHT, cardHeaderHeight: CARD_HEADER_HEIGHT,
@@ -941,6 +969,7 @@ onUnmounted(stopDrag);
<SelectContent> <SelectContent>
<SelectItem value="one-to-many">{{ t("diagram.cardinalityOneToMany") }}</SelectItem> <SelectItem value="one-to-many">{{ t("diagram.cardinalityOneToMany") }}</SelectItem>
<SelectItem value="many-to-one">{{ t("diagram.cardinalityManyToOne") }}</SelectItem> <SelectItem value="many-to-one">{{ t("diagram.cardinalityManyToOne") }}</SelectItem>
<SelectItem value="many-to-many">{{ t("diagram.cardinalityManyToMany") }}</SelectItem>
<SelectItem value="one-to-one">{{ t("diagram.cardinalityOneToOne") }}</SelectItem> <SelectItem value="one-to-one">{{ t("diagram.cardinalityOneToOne") }}</SelectItem>
</SelectContent> </SelectContent>
</Select> </Select>
@@ -1026,9 +1055,39 @@ onUnmounted(stopDrag);
<path d="M 0 0 L 8 4 L 0 8 z" class="fill-primary/70" /> <path d="M 0 0 L 8 4 L 0 8 z" class="fill-primary/70" />
</marker> </marker>
</defs> </defs>
<path v-for="relationship in visibleRelationships" :key="relationship.id" :d="relationshipPath(relationship)" class="fill-none stroke-primary/55" stroke-width="1.6" marker-end="url(#diagram-arrow)"> <template v-for="relationship in visibleRelationships" :key="relationship.id">
<title>{{ relationshipTitle(relationship) }}</title> <path :d="tableRelationshipLayouts[relationship.id]?.path" class="fill-none stroke-primary/55" stroke-width="1.6" marker-end="url(#diagram-arrow)">
</path> <title>{{ relationshipTitle(relationship) }}</title>
</path>
<text
:data-relationship-id="relationship.id"
data-cardinality-end="source"
:x="tableRelationshipLayouts[relationship.id]?.sourceCardinality.x"
:y="tableRelationshipLayouts[relationship.id]?.sourceCardinality.y"
text-anchor="middle"
dominant-baseline="middle"
paint-order="stroke"
stroke-width="4"
stroke-linejoin="round"
class="fill-foreground stroke-background text-[12px] font-semibold"
>
{{ relationship.sourceCardinality }}
</text>
<text
:data-relationship-id="relationship.id"
data-cardinality-end="target"
:x="tableRelationshipLayouts[relationship.id]?.targetCardinality.x"
:y="tableRelationshipLayouts[relationship.id]?.targetCardinality.y"
text-anchor="middle"
dominant-baseline="middle"
paint-order="stroke"
stroke-width="4"
stroke-linejoin="round"
class="fill-foreground stroke-background text-[12px] font-semibold"
>
{{ relationship.targetCardinality }}
</text>
</template>
</svg> </svg>
<div <div
+1
View File
@@ -2831,6 +2831,7 @@ export default {
cardinality: "Cardinality", cardinality: "Cardinality",
cardinalityOneToMany: "1:N", cardinalityOneToMany: "1:N",
cardinalityManyToOne: "N:1", cardinalityManyToOne: "N:1",
cardinalityManyToMany: "N:N",
cardinalityOneToOne: "1:1", cardinalityOneToOne: "1:1",
addRelationship: "Add relationship", addRelationship: "Add relationship",
removeRelationship: "Remove relationship", removeRelationship: "Remove relationship",
+1
View File
@@ -2691,6 +2691,7 @@ export default withEnglishFallback({
cardinality: "Cardinalidad", cardinality: "Cardinalidad",
cardinalityOneToMany: "1:N", cardinalityOneToMany: "1:N",
cardinalityManyToOne: "N:1", cardinalityManyToOne: "N:1",
cardinalityManyToMany: "N:N",
cardinalityOneToOne: "1:1", cardinalityOneToOne: "1:1",
addRelationship: "Agregar relación", addRelationship: "Agregar relación",
removeRelationship: "Eliminar relación", removeRelationship: "Eliminar relación",
+1
View File
@@ -2680,6 +2680,7 @@ export default withEnglishFallback({
cardinality: "Cardinalita", cardinality: "Cardinalita",
cardinalityOneToMany: "1:N", cardinalityOneToMany: "1:N",
cardinalityManyToOne: "N:1", cardinalityManyToOne: "N:1",
cardinalityManyToMany: "N:N",
cardinalityOneToOne: "1:1", cardinalityOneToOne: "1:1",
addRelationship: "Aggiungi relazione", addRelationship: "Aggiungi relazione",
removeRelationship: "Rimuovi relazione", removeRelationship: "Rimuovi relazione",
+1
View File
@@ -2746,6 +2746,7 @@ export default withEnglishFallback({
cardinality: "カーディナリティ", cardinality: "カーディナリティ",
cardinalityOneToMany: "1:N", cardinalityOneToMany: "1:N",
cardinalityManyToOne: "N:1", cardinalityManyToOne: "N:1",
cardinalityManyToMany: "N:N",
cardinalityOneToOne: "1:1", cardinalityOneToOne: "1:1",
addRelationship: "関係を追加", addRelationship: "関係を追加",
removeRelationship: "関係を削除", removeRelationship: "関係を削除",
+1
View File
@@ -2787,6 +2787,7 @@ export default withEnglishFallback({
cardinality: "카디널리티", cardinality: "카디널리티",
cardinalityOneToMany: "1:N", cardinalityOneToMany: "1:N",
cardinalityManyToOne: "N:1", cardinalityManyToOne: "N:1",
cardinalityManyToMany: "N:N",
cardinalityOneToOne: "1:1", cardinalityOneToOne: "1:1",
addRelationship: "관계 추가", addRelationship: "관계 추가",
removeRelationship: "관계 제거", removeRelationship: "관계 제거",
+1
View File
@@ -2682,6 +2682,7 @@ export default withEnglishFallback({
cardinality: "Cardinalidade", cardinality: "Cardinalidade",
cardinalityOneToMany: "1:N", cardinalityOneToMany: "1:N",
cardinalityManyToOne: "N:1", cardinalityManyToOne: "N:1",
cardinalityManyToMany: "N:N",
cardinalityOneToOne: "1:1", cardinalityOneToOne: "1:1",
addRelationship: "Adicionar relacionamento", addRelationship: "Adicionar relacionamento",
removeRelationship: "Remover relacionamento", removeRelationship: "Remover relacionamento",
+1
View File
@@ -2831,6 +2831,7 @@ export default withEnglishFallback({
cardinality: "基数", cardinality: "基数",
cardinalityOneToMany: "1:N", cardinalityOneToMany: "1:N",
cardinalityManyToOne: "N:1", cardinalityManyToOne: "N:1",
cardinalityManyToMany: "N:N",
cardinalityOneToOne: "1:1", cardinalityOneToOne: "1:1",
addRelationship: "添加关系", addRelationship: "添加关系",
removeRelationship: "删除关系", removeRelationship: "删除关系",
+1
View File
@@ -2559,6 +2559,7 @@ export default withEnglishFallback({
cardinality: "基數", cardinality: "基數",
cardinalityOneToMany: "1:N", cardinalityOneToMany: "1:N",
cardinalityManyToOne: "N:1", cardinalityManyToOne: "N:1",
cardinalityManyToMany: "N:N",
cardinalityOneToOne: "1:1", cardinalityOneToOne: "1:1",
addRelationship: "新增關係", addRelationship: "新增關係",
removeRelationship: "移除關係", removeRelationship: "移除關係",
+21 -2
View File
@@ -1,9 +1,10 @@
import type { ColumnInfo, ForeignKeyInfo } from "@/types/database"; import type { ColumnInfo, ForeignKeyInfo, IndexInfo } from "@/types/database";
export interface DiagramTable { export interface DiagramTable {
name: string; name: string;
columns: ColumnInfo[]; columns: ColumnInfo[];
foreignKeys: ForeignKeyInfo[]; foreignKeys: ForeignKeyInfo[];
indexes?: IndexInfo[];
} }
export interface DiagramRelationship { export interface DiagramRelationship {
@@ -56,6 +57,24 @@ function columnExists(table: DiagramTable | undefined, columnName: string): bool
return !!table?.columns.some((column) => column.name === columnName); return !!table?.columns.some((column) => column.name === columnName);
} }
function sourceColumnsContainUniqueKey(sourceColumns: string[], keyColumns: string[]): boolean {
if (keyColumns.length === 0) return false;
const sourceColumnSet = new Set(sourceColumns);
return keyColumns.every((column) => sourceColumnSet.has(column));
}
function foreignKeySourceColumns(table: DiagramTable, foreignKey: ForeignKeyInfo): string[] {
if (!foreignKey.name) return [foreignKey.column];
return table.foreignKeys.filter((candidate) => candidate.name === foreignKey.name && candidate.ref_table === foreignKey.ref_table).map((candidate) => candidate.column);
}
function foreignKeySourceCardinality(table: DiagramTable, foreignKey: ForeignKeyInfo): "1" | "N" {
const sourceColumns = foreignKeySourceColumns(table, foreignKey);
const primaryKeyColumns = table.columns.filter((column) => column.is_primary_key).map((column) => column.name);
if (sourceColumnsContainUniqueKey(sourceColumns, primaryKeyColumns)) return "1";
return table.indexes?.some((index) => (index.is_unique || index.is_primary) && !index.filter?.trim() && sourceColumnsContainUniqueKey(sourceColumns, index.columns)) ? "1" : "N";
}
function customRelationshipId(relationship: Omit<CustomDiagramRelationship, "id">): string { function customRelationshipId(relationship: Omit<CustomDiagramRelationship, "id">): string {
return ["custom", relationship.sourceTable, relationship.sourceColumn, relationship.targetTable, relationship.targetColumn, relationship.sourceCardinality, relationship.targetCardinality].join(":"); return ["custom", relationship.sourceTable, relationship.sourceColumn, relationship.targetTable, relationship.targetColumn, relationship.sourceCardinality, relationship.targetCardinality].join(":");
} }
@@ -82,7 +101,7 @@ export function buildDiagramRelationships(tables: DiagramTable[], customRelation
sourceColumn: fk.column, sourceColumn: fk.column,
targetTable: fk.ref_table, targetTable: fk.ref_table,
targetColumn: fk.ref_column, targetColumn: fk.ref_column,
sourceCardinality: "N" as const, sourceCardinality: foreignKeySourceCardinality(table, fk),
targetCardinality: "1" as const, targetCardinality: "1" as const,
})), })),
); );
@@ -8,11 +8,18 @@ interface DiagramCanvas {
height: number; height: number;
} }
export interface TableDiagramRelationshipLayout {
path: string;
routePoints: DiagramPosition[];
sourceCardinality: DiagramPosition;
targetCardinality: DiagramPosition;
}
export interface TableDiagramSvgOptions { export interface TableDiagramSvgOptions {
tables: DiagramTable[]; tables: DiagramTable[];
relationships: DiagramRelationship[]; relationships: DiagramRelationship[];
positions: Record<string, DiagramPosition>; positions: Record<string, DiagramPosition>;
relationshipPaths: Record<string, string>; relationshipLayouts: Record<string, TableDiagramRelationshipLayout>;
canvas: DiagramCanvas; canvas: DiagramCanvas;
cardWidth: number; cardWidth: number;
cardHeaderHeight: number; cardHeaderHeight: number;
@@ -30,8 +37,18 @@ function svgNumber(value: number): string {
return Number.isInteger(value) ? String(value) : value.toFixed(2).replace(/\.?0+$/, ""); return Number.isInteger(value) ? String(value) : value.toFixed(2).replace(/\.?0+$/, "");
} }
function svgHeader(canvas: DiagramCanvas): string { interface SvgViewport {
return [`<svg xmlns="http://www.w3.org/2000/svg" width="${svgNumber(canvas.width)}" height="${svgNumber(canvas.height)}" viewBox="0 0 ${svgNumber(canvas.width)} ${svgNumber(canvas.height)}">`, '<rect width="100%" height="100%" fill="#fafafa"/>'].join(""); x: number;
y: number;
width: number;
height: number;
}
function svgHeader(canvas: DiagramCanvas, viewport: SvgViewport = { x: 0, y: 0, width: canvas.width, height: canvas.height }): string {
return [
`<svg xmlns="http://www.w3.org/2000/svg" width="${svgNumber(viewport.width)}" height="${svgNumber(viewport.height)}" viewBox="${svgNumber(viewport.x)} ${svgNumber(viewport.y)} ${svgNumber(viewport.width)} ${svgNumber(viewport.height)}">`,
`<rect x="${svgNumber(viewport.x)}" y="${svgNumber(viewport.y)}" width="${svgNumber(viewport.width)}" height="${svgNumber(viewport.height)}" fill="#fafafa"/>`,
].join("");
} }
function svgText( function svgText(
@@ -45,12 +62,22 @@ function svgText(
anchor?: "start" | "middle" | "end"; anchor?: "start" | "middle" | "end";
family?: string; family?: string;
decoration?: string; decoration?: string;
stroke?: string;
strokeWidth?: number;
paintOrder?: string;
attributes?: Record<string, string>;
} = {}, } = {},
): string { ): string {
const attrs = [`x="${svgNumber(x)}"`, `y="${svgNumber(y)}"`, `fill="${options.fill ?? "#18181b"}"`, `font-size="${options.size ?? 12}"`, `font-family="${options.family ?? "Arial, Helvetica, sans-serif"}"`, 'dominant-baseline="middle"']; const attrs = [`x="${svgNumber(x)}"`, `y="${svgNumber(y)}"`, `fill="${options.fill ?? "#18181b"}"`, `font-size="${options.size ?? 12}"`, `font-family="${options.family ?? "Arial, Helvetica, sans-serif"}"`, 'dominant-baseline="middle"'];
if (options.weight) attrs.push(`font-weight="${options.weight}"`); if (options.weight) attrs.push(`font-weight="${options.weight}"`);
if (options.anchor) attrs.push(`text-anchor="${options.anchor}"`); if (options.anchor) attrs.push(`text-anchor="${options.anchor}"`);
if (options.decoration) attrs.push(`text-decoration="${options.decoration}"`); if (options.decoration) attrs.push(`text-decoration="${options.decoration}"`);
if (options.stroke) attrs.push(`stroke="${options.stroke}"`);
if (options.strokeWidth) attrs.push(`stroke-width="${svgNumber(options.strokeWidth)}"`);
if (options.paintOrder) attrs.push(`paint-order="${options.paintOrder}"`);
for (const [name, value] of Object.entries(options.attributes ?? {})) {
attrs.push(`${name}="${escapeXml(value)}"`);
}
return `<text ${attrs.join(" ")}>${escapeXml(label)}</text>`; return `<text ${attrs.join(" ")}>${escapeXml(label)}</text>`;
} }
@@ -68,15 +95,62 @@ function isForeignKeyColumn(table: DiagramTable, columnName: string): boolean {
return table.foreignKeys.some((fk) => fk.column === columnName); return table.foreignKeys.some((fk) => fk.column === columnName);
} }
function tableDiagramViewport(options: TableDiagramSvgOptions): SvgViewport {
const relationshipPadding = 20;
let minX = 0;
let minY = 0;
let maxX = options.canvas.width;
let maxY = options.canvas.height;
for (const layout of Object.values(options.relationshipLayouts)) {
const points = [...layout.routePoints, layout.sourceCardinality, layout.targetCardinality];
for (const point of points) {
minX = Math.min(minX, point.x - relationshipPadding);
minY = Math.min(minY, point.y - relationshipPadding);
maxX = Math.max(maxX, point.x + relationshipPadding);
maxY = Math.max(maxY, point.y + relationshipPadding);
}
}
return { x: minX, y: minY, width: maxX - minX, height: maxY - minY };
}
export function buildTableDiagramSvg(options: TableDiagramSvgOptions): string { export function buildTableDiagramSvg(options: TableDiagramSvgOptions): string {
const parts = [svgHeader(options.canvas), tableDiagramDefs(), '<g fill="none" stroke="#2563eb" stroke-opacity="0.58" stroke-width="1.6">']; const parts = [svgHeader(options.canvas, tableDiagramViewport(options)), tableDiagramDefs()];
for (const relationship of options.relationships) { for (const relationship of options.relationships) {
const path = options.relationshipPaths[relationship.id]; const layout = options.relationshipLayouts[relationship.id];
if (!path) continue; if (!layout?.path) continue;
parts.push(`<path d="${escapeXml(path)}" marker-end="url(#dbx-diagram-arrow)">` + `<title>${escapeXml(`${relationship.sourceTable}.${relationship.sourceColumn} -> ${relationship.targetTable}.${relationship.targetColumn}`)}</title>` + "</path>"); parts.push(`<g data-relationship-id="${escapeXml(relationship.id)}">`);
parts.push(
`<path d="${escapeXml(layout.path)}" fill="none" stroke="#2563eb" stroke-opacity="0.58" stroke-width="1.6" marker-end="url(#dbx-diagram-arrow)">` +
`<title>${escapeXml(`${relationship.sourceTable}.${relationship.sourceColumn} (${relationship.sourceCardinality}:${relationship.targetCardinality}) -> ${relationship.targetTable}.${relationship.targetColumn}`)}</title>` +
"</path>",
);
parts.push(
svgText(relationship.sourceCardinality, layout.sourceCardinality.x, layout.sourceCardinality.y, {
size: 12,
weight: "600",
anchor: "middle",
stroke: "#fafafa",
strokeWidth: 4,
paintOrder: "stroke",
attributes: { "data-cardinality-end": "source" },
}),
);
parts.push(
svgText(relationship.targetCardinality, layout.targetCardinality.x, layout.targetCardinality.y, {
size: 12,
weight: "600",
anchor: "middle",
stroke: "#fafafa",
strokeWidth: 4,
paintOrder: "stroke",
attributes: { "data-cardinality-end": "target" },
}),
);
parts.push("</g>");
} }
parts.push("</g>");
for (const table of options.tables) { for (const table of options.tables) {
const position = options.positions[table.name] ?? { x: 0, y: 0 }; const position = options.positions[table.name] ?? { x: 0, y: 0 };
+131 -3
View File
@@ -2,7 +2,7 @@ import { strict as assert } from "node:assert";
import { test } from "vitest"; import { test } from "vitest";
import { buildEngineeringDiagram } from "../../apps/desktop/src/lib/diagram/engineeringDiagram.ts"; import { buildEngineeringDiagram } from "../../apps/desktop/src/lib/diagram/engineeringDiagram.ts";
import { buildEngineeringDiagramSvg, buildTableDiagramSvg, diagramSvgFileName } from "../../apps/desktop/src/lib/export/diagramSvgExport.ts"; import { buildEngineeringDiagramSvg, buildTableDiagramSvg, diagramSvgFileName } from "../../apps/desktop/src/lib/export/diagramSvgExport.ts";
import { buildDiagramRelationships, type DiagramTable } from "../../apps/desktop/src/lib/diagram/erDiagram.ts"; import { buildDiagramRelationships, normalizeCustomDiagramRelationship, type DiagramTable } from "../../apps/desktop/src/lib/diagram/erDiagram.ts";
const tables: DiagramTable[] = [ const tables: DiagramTable[] = [
{ {
@@ -32,8 +32,16 @@ test("exports the table diagram as standalone SVG", () => {
users: { x: 40, y: 40 }, users: { x: 40, y: 40 },
orders: { x: 360, y: 40 }, orders: { x: 360, y: 40 },
}, },
relationshipPaths: { relationshipLayouts: {
[relationships[0].id]: "M 360 96 L 310 96", [relationships[0].id]: {
path: "M 360 96 L 310 96",
routePoints: [
{ x: 360, y: 96 },
{ x: 310, y: 96 },
],
sourceCardinality: { x: 346, y: 86 },
targetCardinality: { x: 324, y: 86 },
},
}, },
canvas: { width: 720, height: 320 }, canvas: { width: 720, height: 320 },
cardWidth: 270, cardWidth: 270,
@@ -45,12 +53,132 @@ test("exports the table diagram as standalone SVG", () => {
assert.match(svg, /^<svg /); assert.match(svg, /^<svg /);
assert.match(svg, /<path d="M 360 96 L 310 96"/); assert.match(svg, /<path d="M 360 96 L 310 96"/);
assert.match(svg, /data-cardinality-end="source"[^>]*>N<\/text>/);
assert.match(svg, /data-cardinality-end="target"[^>]*>1<\/text>/);
assert.match(svg, /orders\.user_id \(N:1\) -&gt; users\.id/);
assert.match(svg, />users</); assert.match(svg, />users</);
assert.match(svg, />orders</); assert.match(svg, />orders</);
assert.match(svg, />name &amp; note</); assert.match(svg, />name &amp; note</);
assert.doesNotMatch(svg, /<foreignObject/); assert.doesNotMatch(svg, /<foreignObject/);
}); });
test("exports many-to-many cardinalities at both relationship endpoints", () => {
const customRelationship = {
...normalizeCustomDiagramRelationship({
name: "users_orders",
sourceTable: "users",
sourceColumn: "id",
targetTable: "orders",
targetColumn: "id",
sourceCardinality: "N",
targetCardinality: "N",
}),
kind: "custom" as const,
};
const svg = buildTableDiagramSvg({
tables,
relationships: [customRelationship],
positions: {
users: { x: 40, y: 40 },
orders: { x: 360, y: 40 },
},
relationshipLayouts: {
[customRelationship.id]: {
path: "M 310 96 L 360 96",
routePoints: [
{ x: 310, y: 96 },
{ x: 360, y: 96 },
],
sourceCardinality: { x: 324, y: 86 },
targetCardinality: { x: 346, y: 86 },
},
},
canvas: { width: 720, height: 320 },
cardWidth: 270,
cardHeaderHeight: 44,
columnRowHeight: 24,
maxVisibleColumns: 9,
});
assert.match(svg, /data-cardinality-end="source"[^>]*>N<\/text>/);
assert.match(svg, /data-cardinality-end="target"[^>]*>N<\/text>/);
assert.match(svg, /users\.id \(N:N\) -&gt; orders\.id/);
});
test("infers one-to-one foreign keys from primary and unique source columns", () => {
const primaryKeyTables: DiagramTable[] = [
tables[0],
{
...tables[1],
columns: tables[1].columns.map((column) => ({ ...column, is_primary_key: column.name === "user_id" })),
},
];
assert.equal(buildDiagramRelationships(primaryKeyTables)[0].sourceCardinality, "1");
const uniqueIndexTables: DiagramTable[] = [
tables[0],
{
...tables[1],
indexes: [{ name: "orders_user_id_unique", columns: ["user_id"], is_unique: true, is_primary: false }],
},
];
assert.equal(buildDiagramRelationships(uniqueIndexTables)[0].sourceCardinality, "1");
const sourceColumnsContainingUniqueKey: DiagramTable[] = [
tables[0],
{
...tables[1],
columns: [...tables[1].columns, { name: "tenant_id", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: false, extra: null }],
foreignKeys: [...tables[1].foreignKeys, { name: "orders_user_id_fk", column: "tenant_id", ref_table: "users", ref_column: "tenant_id" }],
indexes: [{ name: "orders_user_id_unique", columns: ["user_id"], is_unique: true, is_primary: false }],
},
];
assert.equal(buildDiagramRelationships(sourceColumnsContainingUniqueKey)[0].sourceCardinality, "1");
const partialUniqueIndexTables: DiagramTable[] = [
tables[0],
{
...tables[1],
indexes: [{ name: "orders_user_id_active_unique", columns: ["user_id"], is_unique: true, is_primary: false, filter: "deleted_at IS NULL" }],
},
];
assert.equal(buildDiagramRelationships(partialUniqueIndexTables)[0].sourceCardinality, "N");
});
test("expands the exported viewBox for a relationship routed left of the canvas", () => {
const relationships = buildDiagramRelationships(tables);
const svg = buildTableDiagramSvg({
tables,
relationships,
positions: {
users: { x: 16, y: 40 },
orders: { x: 336, y: 40 },
},
relationshipLayouts: {
[relationships[0].id]: {
path: "M 14 96 L -20 96 L -20 120 L 14 120",
routePoints: [
{ x: 14, y: 96 },
{ x: -20, y: 96 },
{ x: -20, y: 120 },
{ x: 14, y: 120 },
],
sourceCardinality: { x: 0, y: 86 },
targetCardinality: { x: 0, y: 110 },
},
},
canvas: { width: 720, height: 320 },
cardWidth: 270,
cardHeaderHeight: 44,
columnRowHeight: 24,
maxVisibleColumns: 9,
});
assert.match(svg, /viewBox="-40 0 760 320"/);
assert.match(svg, /<rect x="-40" y="0" width="760" height="320" fill="#fafafa"/);
assert.match(svg, /<path d="M 14 96 L -20 96 L -20 120 L 14 120"/);
});
test("exports the engineering ER diagram with Chen-style shapes and cardinalities", () => { test("exports the engineering ER diagram with Chen-style shapes and cardinalities", () => {
const relationships = buildDiagramRelationships(tables); const relationships = buildDiagramRelationships(tables);
const diagram = buildEngineeringDiagram(tables, relationships, { const diagram = buildEngineeringDiagram(tables, relationships, {