Skip to content

Free, simple, and intuitive online database diagram editor and SQL generator.

Add extendable interface (#1027)

1ilit381e5bc35129
diff --git a/src/components/EditorCanvas/Canvas.jsx b/src/components/EditorCanvas/Canvas.jsx
index 89fe1301..f556daed 100644
--- a/src/components/EditorCanvas/Canvas.jsx
+++ b/src/components/EditorCanvas/Canvas.jsx
@@ -1,4 +1,5 @@
-import { useRef, useState } from "react";
+import { useEffect, useRef, useState } from "react";
+import { Slot } from "../../context/ExtensionsContext";
import {
Action,
Cardinality,
@@ -25,6 +26,7 @@ import {
useNotes,
useLayout,
useSaveState,
+ useCollab,
} from "../../hooks";
import { useTranslation } from "react-i18next";
import { useEventListener } from "usehooks-ts";
@@ -75,6 +77,32 @@ export default function Canvas() {
endX: 0,
endY: 0,
});
+ const { emitAwareness } = useCollab();
+ const lastLinkingRef = useRef(false);
+
+ useEffect(() => {
+ if (linking) {
+ emitAwareness({
+ linking: {
+ startX: linkingLine.startX,
+ startY: linkingLine.startY,
+ endX: linkingLine.endX,
+ endY: linkingLine.endY,
+ },
+ });
+ lastLinkingRef.current = true;
+ } else if (lastLinkingRef.current) {
+ emitAwareness({ linking: null });
+ lastLinkingRef.current = false;
+ }
+ }, [
+ linking,
+ linkingLine.startX,
+ linkingLine.startY,
+ linkingLine.endX,
+ linkingLine.endY,
+ emitAwareness,
+ ]);
const [hoveredTable, setHoveredTable] = useState({
tableId: null,
fieldId: null,
@@ -771,6 +799,7 @@ export default function Canvas() {
className="pointer-events-none touch-none"
/>
)}
+ <Slot name="svg-overlay" />
{notes.map((n) => (
<Note
key={n.id}
diff --git a/src/components/EditorHeader/ControlPanel.jsx b/src/components/EditorHeader/ControlPanel.jsx
index ca4e4286..eed3703f 100644
--- a/src/components/EditorHeader/ControlPanel.jsx
+++ b/src/components/EditorHeader/ControlPanel.jsx
@@ -1,4 +1,5 @@
import { useContext, useState } from "react";
+import { Slot, useExtensions } from "../../context/ExtensionsContext";
import { createPortal } from "react-dom";
import {
IconCaretdown,
@@ -91,6 +92,7 @@ export default function ControlPanel({
title,
setTitle,
lastSaved,
+ setLastSaved,
toolbarContainer,
}) {
const { id: diagramId } = useParams();
@@ -134,6 +136,7 @@ export default function ControlPanel({
const { version, gistId, setGistId } = useContext(IdContext);
const isTemplate = useMatch("/editor/templates/:id");
const navigate = useNavigateWithParams();
+ const extensions = useExtensions();
const undo = () => {
if (undoStack.length === 0) return;
@@ -755,7 +758,47 @@ export default function ControlPanel({
const toggleDBMLEditor = () => {
setLayout((prev) => ({ ...prev, dbmlEditor: !prev.dbmlEditor }));
};
- const save = () => setSaveState(State.SAVING);
+ const save = async () => {
+ if (typeof extensions.cloudSave === "function") {
+ // TODO: dont have blank here have null
+ const isNew = diagramId === 'blank';
+ const newId = isNew ? crypto.randomUUID() : diagramId;
+ const diagramData = {
+ diagramId: newId,
+ database,
+ name: title,
+ gistId: gistId ?? "",
+ lastModified: new Date(),
+ tables,
+ references: relationships,
+ notes,
+ areas,
+ pan: transform.pan,
+ zoom: transform.zoom,
+ ...(databases[database].hasEnums && { enums }),
+ ...(databases[database].hasTypes && { types }),
+ };
+ try {
+ await extensions.cloudSave(diagramData, { isNew });
+ if (isNew) {
+ navigate(`/editor/diagrams/${newId}`, { replace: true });
+ }
+ setSaveState(State.SAVED);
+ if (typeof setLastSaved === "function") {
+ setLastSaved(new Date().toLocaleString());
+ }
+ } catch (err) {
+ if (err?.response?.status === 402) {
+ setSaveState(State.NONE);
+ navigate("/checkout?tier=solo_pro");
+ return;
+ }
+ setSaveState(State.ERROR);
+ }
+ return;
+ }
+ setSaveState(State.SAVING);
+ };
const recentlyOpenedDiagrams = useLiveQuery(() =>
db.diagrams.orderBy("lastModified").reverse().limit(10).toArray(),
);
@@ -847,24 +890,29 @@ export default function ControlPanel({
message: t("are_you_sure_delete_diagram"),
},
function: async () => {
- await db.diagrams
- .where("diagramId")
- .equals(diagramId)
- .delete()
- .then(() => {
- setTitle("Untitled diagram");
- setTables([]);
- setRelationships([]);
- setAreas([]);
- setNotes([]);
- setTypes([]);
- setEnums([]);
- setUndoStack([]);
- setRedoStack([]);
- setGistId("");
- navigate("/editor/templates/blank", { replace: true });
- })
- .catch(() => Toast.error(t("oops_smth_went_wrong")));
+ try {
+ if (typeof extensions.cloudDelete === "function") {
+ await extensions.cloudDelete(diagramId);
+ } else {
+ await db.diagrams
+ .where("diagramId")
+ .equals(diagramId)
+ .delete();
+ }
+ setTitle("Untitled diagram");
+ setTables([]);
+ setRelationships([]);
+ setAreas([]);
+ setNotes([]);
+ setTypes([]);
+ setEnums([]);
+ setUndoStack([]);
+ setRedoStack([]);
+ setGistId("");
+ navigate("/editor/templates/blank", { replace: true });
+ } catch {
+ Toast.error(t("oops_smth_went_wrong"));
+ }
},
},
import_from: {
@@ -1582,17 +1630,21 @@ export default function ControlPanel({
style={isRtl(i18n.language) ? { direction: "rtl" } : {}}
>
{header()}
- {!isTemplate && (
- <Button
- type="primary"
- className="!text-base me-8 !pe-6 !ps-5 !py-[18px] !rounded-md"
- size="default"
- icon={<IconShareStroked />}
- onClick={() => setModal(MODAL.SHARE)}
- >
- {t("share")}
- </Button>
- )}
+ <div className="flex items-center gap-2 me-7">
+ <Slot name="header-actions-start" />
+ {!isTemplate && (
+ <Button
+ type="primary"
+ className="!text-base !pe-6 !ps-5 !py-[18px] !rounded-md"
+ size="default"
+ icon={<IconShareStroked />}
+ onClick={() => setModal(MODAL.SHARE)}
+ >
+ {t("share")}
+ </Button>
+ )}
+ <Slot name="header-actions-end" />
+ </div>
</div>
)}
{layout.toolbar &&
@@ -1852,7 +1904,7 @@ export default function ControlPanel({
}}
onClick={!layout.readOnly && (() => setModal(MODAL.RENAME))}
>
- <span>{(isTemplate ? "Templates/" : "Diagrams/") + title}</span>
+ <span>{(isTemplate ? "Templates / " : "Diagrams / ") + title}</span>
{version && (
<Tag className="mt-1" color="blue" size="small">
{version.substring(0, 7)}
diff --git a/src/components/EditorHeader/Modal/Open.jsx b/src/components/EditorHeader/Modal/Open.jsx
index 4758c399..3dbfa389 100644
--- a/src/components/EditorHeader/Modal/Open.jsx
+++ b/src/components/EditorHeader/Modal/Open.jsx
@@ -1,78 +1,249 @@
-import { db } from "../../../data/db";
-import { Banner } from "@douyinfe/semi-ui";
+import { useEffect, useState } from "react";
+import { Banner, Spin, Tag } from "@douyinfe/semi-ui";
import { useLiveQuery } from "dexie-react-hooks";
import { useTranslation } from "react-i18next";
+import { db } from "../../../data/db";
import { databases } from "../../../data/databases";
+import { useExtensions } from "../../../context/ExtensionsContext";
+
+function formatSize(bytes) {
+ if (bytes == null) return "";
+ if (bytes >= 1024 * 1024) return (bytes / (1024 * 1024)).toFixed(1) + "MB";
+ if (bytes >= 1024) return (bytes / 1024).toFixed(1) + "KB";
+ return bytes + "B";
+}
+
+function useDiagramList() {
+ const extensions = useExtensions();
+ const cloudList = extensions?.cloudList;
+ const cloudEnabled = typeof cloudList === "function";
+ const cloudCurrentUserId = extensions?.cloudCurrentUserId ?? null;
+
+ const localDiagrams = useLiveQuery(() => db.diagrams.toArray(), []);
+
+ const [cloudState, setCloudState] = useState(() => ({
+ loading: cloudEnabled,
+ error: null,
+ items: null,
+ }));
+
+ useEffect(() => {
+ if (!cloudEnabled) {
+ setCloudState({ loading: false, error: null, items: [] });
+ return undefined;
+ }
+ let cancelled = false;
+ setCloudState({ loading: true, error: null, items: null });
+ cloudList()
+ .then((items) => {
+ if (cancelled) return;
+ setCloudState({ loading: false, error: null, items });
+ })
+ .catch((err) => {
+ if (cancelled) return;
+ setCloudState({
+ loading: false,
+ error: err?.response?.data?.error || err?.message || "Failed to load",
+ items: null,
+ });
+ });
+ return () => {
+ cancelled = true;
+ };
+ }, [cloudEnabled, cloudList]);
+
+ return {
+ loading: cloudState.loading || localDiagrams === undefined,
+ error: cloudState.error,
+ cloud: cloudState.items ?? [],
+ local: localDiagrams ?? [],
+ cloudEnabled,
+ currentUserId: cloudCurrentUserId,
+ };
+}
+
+function ownerLabel(d, currentUserId) {
+ if (!d?.owner) return null;
+ if (currentUserId && String(d.owner.id) === String(currentUserId)) {
+ return "You";
+ }
+ return d.owner.username || d.owner.email || `User ${d.owner.id}`;
+}
+
+function DiagramTable({
+ items,
+ isCloud,
+ currentUserId,
+ selectedDiagramId,
+ setSelectedDiagramId,
+ cloudRowActions,
+}) {
+ const { t } = useTranslation();
+ const showOwner =
+ isCloud &&
+ items.some((d) => d.owner && String(d.owner.id) !== String(currentUserId));
+ const showRowActions = isCloud && typeof cloudRowActions === "function";
+
+ return (
+ <table className="w-full text-left border-separate border-spacing-x-0">
+ <thead>
+ <tr>
+ <th>{t("name")}</th>
+ {showOwner && <th>Owner</th>}
+ <th>{t("last_modified")}</th>
+ <th>{t("size")}</th>
+ <th>{t("type")}</th>
+ {showRowActions && <th />}
+ </tr>
+ </thead>
+ <tbody>
+ {items.map((d) => {
+ const lastModified =
+ d.lastModified instanceof Date
+ ? d.lastModified
+ : d.lastModified
+ ? new Date(d.lastModified)
+ : null;
+ const size = isCloud
+ ? formatSize(d.sizeBytes)
+ : formatSize(JSON.stringify(d).length);
+ const dbInfo = databases[d.database];
+ const owner = ownerLabel(d, currentUserId);
+ return (
+ <tr
+ key={d.diagramId}
+ className={`cursor-pointer ${
+ selectedDiagramId === d.diagramId
+ ? "bg-blue-300/30"
+ : "hover-1"
+ }`}
+ onClick={() => setSelectedDiagramId(d.diagramId)}
+ >
+ <td className="py-1">
+ <i className="bi bi-file-earmark-text text-[16px] me-1 opacity-60" />
+ {d.name}
+ </td>
+ {showOwner && (
+ <td className="py-1">
+ {owner === "You" ? (
+ <Tag size="small" color="blue">
+ You
+ </Tag>
+ ) : (
+ <span className="text-sm">{owner}</span>
+ )}
+ </td>
+ )}
+ <td className="py-1">
+ {lastModified
+ ? lastModified.toLocaleDateString() +
+ " " +
+ lastModified.toLocaleTimeString()
+ : ""}
+ </td>
+ <td className="py-1">{size}</td>
+ <td className="py-1">{dbInfo?.name ?? "Generic"}</td>
+ {showRowActions && (
+ <td
+ className="py-1 text-right"
+ onClick={(e) => e.stopPropagation()}
+ >
+ {cloudRowActions(d)}
+ </td>
+ )}
+ </tr>
+ );
+ })}
+ </tbody>
+ </table>
+ );
+}
+
+function SectionHeader({ children }) {
+ return (
+ <h4 className="text-xs uppercase tracking-wider text-zinc-500 dark:text-zinc-400 mb-1 mt-2 first:mt-0">
+ {children}
+ </h4>
+ );
+}
export default function Open({ selectedDiagramId, setSelectedDiagramId }) {
- const diagrams = useLiveQuery(() => db.diagrams.toArray());
const { t } = useTranslation();
+ const { loading, error, cloud, local, cloudEnabled, currentUserId } =
+ useDiagramList();
+ const extensions = useExtensions();
+ const cloudRowActions = extensions?.cloudRowActions;
- const getDiagramSize = (d) => {
- const size = JSON.stringify(d).length;
- let sizeStr;
- if (size >= 1024 && size < 1024 * 1024)
- sizeStr = (size / 1024).toFixed(1) + "KB";
- else if (size >= 1024 * 1024)
- sizeStr = (size / (1024 * 1024)).toFixed(1) + "MB";
- else sizeStr = size + "B";
+ if (loading) {
+ return (
+ <div className="flex justify-center py-10">
+ <Spin />
+ </div>
+ );
+ }
- return sizeStr;
- };
+ if (error) {
+ return (
+ <Banner
+ fullMode={false}
+ type="danger"
+ bordered
+ icon={null}
+ closeIcon={null}
+ description={<div>{error}</div>}
+ />
+ );
+ }
+
+ const hasCloud = cloud.length > 0;
+ const hasLocal = local.length > 0;
+
+ if (!hasCloud && !hasLocal) {
+ return (
+ <Banner
+ fullMode={false}
+ type="info"
+ bordered
+ icon={null}
+ closeIcon={null}
+ description={<div>{t("no_saved_diagrams")}</div>}
+ />
+ );
+ }
return (
- <div>
- {diagrams?.length === 0 ? (
- <Banner
- fullMode={false}
- type="info"
- bordered
- icon={null}
- closeIcon={null}
- description={<div>{t("no_saved_diagrams")}</div>}
- />
- ) : (
- <div className="max-h-[360px]">
- <table className="w-full text-left border-separate border-spacing-x-0">
- <thead>
- <tr>
- <th>{t("name")}</th>
- <th>{t("last_modified")}</th>
- <th>{t("size")}</th>
- <th>{t("type")}</th>
- </tr>
- </thead>
- <tbody>
- {diagrams?.map((d) => {
- return (
- <tr
- key={d.diagramId}
- className={`${
- selectedDiagramId === d.diagramId ? "bg-blue-300/30" : "hover-1"
- }`}
- onClick={() => {
- setSelectedDiagramId(d.diagramId);
- }}
- >
- <td className="py-1">
- <i className="bi bi-file-earmark-text text-[16px] me-1 opacity-60" />
- {d.name}
- </td>
- <td className="py-1">
- {d.lastModified.toLocaleDateString() +
- " " +
- d.lastModified.toLocaleTimeString()}
- </td>
- <td className="py-1">{getDiagramSize(d)}</td>
- <td className="py-1">
- {databases[d.database].name ?? "Generic"}
- </td>
- </tr>
- );
- })}
- </tbody>
- </table>
- </div>
+ <div className="max-h-[360px] overflow-auto space-y-3">
+ {cloudEnabled && (
+ <section>
+ <SectionHeader>Cloud diagrams</SectionHeader>
+ {hasCloud ? (
+ <DiagramTable
+ items={cloud}
+ isCloud
+ currentUserId={currentUserId}
+ selectedDiagramId={selectedDiagramId}
+ setSelectedDiagramId={setSelectedDiagramId}
+ cloudRowActions={cloudRowActions}
+ />
+ ) : (
+ <div className="text-sm text-zinc-500 dark:text-zinc-400 px-1 py-2">
+ No cloud diagrams yet.
+ </div>
+ )}
+ </section>
+ )}
+ {hasLocal && (
+ <section>
+ {cloudEnabled && <SectionHeader>Local (this browser)</SectionHeader>}
+ <DiagramTable
+ items={local}
+ isCloud={false}
+ currentUserId={currentUserId}
+ selectedDiagramId={selectedDiagramId}
+ setSelectedDiagramId={setSelectedDiagramId}
+ cloudRowActions={cloudRowActions}
+ />
+ </section>
)}
</div>
);
diff --git a/src/components/EditorHeader/Modal/Share.jsx b/src/components/EditorHeader/Modal/Share.jsx
index dd33bdb0..aaba844c 100644
--- a/src/components/EditorHeader/Modal/Share.jsx
+++ b/src/components/EditorHeader/Modal/Share.jsx
@@ -15,6 +15,7 @@ import { databases } from "../../../data/databases";
import { MODAL } from "../../../data/constants";
import { create, patch, SHARE_FILENAME } from "../../../api/gists";
import { getCustomTypes } from "../../../utils/customTypes";
+import { Slot, useExtensions } from "../../../context/ExtensionsContext";
import { queryConfig } from "../../../utils/queryConfig";
export default function Share({ title, setModal }) {
@@ -28,6 +29,10 @@ export default function Share({ title, setModal }) {
const { enums } = useEnums();
const { transform } = useTransform();
const [error, setError] = useState(null);
+
+ const extensions = useExtensions();
+ const customContent = extensions?.["share-modal-content"];
+
const [embedSettings, setEmbedSettings] = useState({
theme: null,
hideHeader: null,
@@ -101,6 +106,10 @@ export default function Share({ title, setModal }) {
}, [gistId, setModal, setGistId]);
useEffect(() => {
+ if (customContent) {
+ setLoading(false);
+ return;
+ }
const updateOrGenerateLink = async () => {
try {
setLoading(true);
@@ -131,17 +140,20 @@ export default function Share({ title, setModal }) {
});
};
- if (loading)
- return (
- <div className="text-blue-500 text-center">
- <Spin size="middle" />
- <div>{t("loading")}</div>
- </div>
- );
+ if (customContent) {
+ return <div>{customContent}</div>;
+ }
return (
<div>
- {error && (
+ <Slot name="share-modal-top" />
+ {loading && (
+ <div className="text-blue-500 text-center">
+ <Spin size="middle" />
+ <div>{t("loading")}</div>
+ </div>
+ )}
+ {!loading && error && (
<Banner
description={t("oops_smth_went_wrong")}
type="danger"
@@ -149,7 +161,7 @@ export default function Share({ title, setModal }) {
fullMode={false}
/>
)}
- {!error && (
+ {!loading && !error && (
<>
<div className="flex gap-3">
<Input value={url} size="large" readonly />
diff --git a/src/components/Workspace.jsx b/src/components/Workspace.jsx
index 40b64075..a6f4f554 100644
--- a/src/components/Workspace.jsx
+++ b/src/components/Workspace.jsx
@@ -1,5 +1,13 @@
-import { useState, useEffect, useCallback, createContext } from "react";
+import {
+ useState,
+ useEffect,
+ useCallback,
+ useMemo,
+ createContext,
+ useContext,
+} from "react";
import ControlPanel from "./EditorHeader/ControlPanel";
+import ExtensionsContext, { Slot } from "../context/ExtensionsContext";
import Canvas from "./EditorCanvas/Canvas";
import { CanvasContextProvider } from "../context/CanvasContext";
import SidePanel from "./EditorSidePanel/SidePanel";
@@ -42,7 +50,7 @@ export const IdContext = createContext({
const SIDEPANEL_MIN_WIDTH = 374;
-export default function WorkSpace() {
+export default function WorkSpace({ forcedDiagramId } = {}) {
const [gistId, setGistId] = useState("");
const [version, setVersion] = useState("");
const [loadedFromGistId, setLoadedFromGistId] = useState("");
@@ -73,11 +81,16 @@ export default function WorkSpace() {
const { undoStack, redoStack, setUndoStack, setRedoStack } = useUndoRedo();
const { t, i18n } = useTranslation();
let [searchParams, setSearchParams] = useSearchParams();
- const { id: loadedDiagramId } = useParams();
- const isDiagram = useMatch("/editor/diagrams/:id");
+ const { id: routeDiagramId } = useParams();
+ const loadedDiagramId = forcedDiagramId ?? routeDiagramId;
+ const editorDiagramMatch = useMatch("/editor/diagrams/:id");
+ const isDiagram = forcedDiagramId ? true : editorDiagramMatch;
const isTemplate = useMatch("/editor/templates/:id");
const navigate = useNavigateWithParams();
+ const extensionValues = useContext(ExtensionsContext);
+ const extensions = useMemo(() => extensionValues ?? {}, [extensionValues]);
+ const cloudOnly = typeof extensions.cloudSave === "function";
const handleResize = (e) => {
if (!resize) return;
@@ -91,6 +104,43 @@ export default function WorkSpace() {
setSearchParams(searchParams, { replace: true });
}
+ if (cloudOnly) {
+ const isNew = !loadedDiagramId || isTemplate;
+ const targetId = isNew ? crypto.randomUUID() : loadedDiagramId;
+ const cloudPayload = {
+ diagramId: targetId,
+ database,
+ name: title,
+ gistId: gistId ?? "",
+ lastModified: new Date(),
+ tables,
+ references: relationships,
+ notes,
+ areas,
+ pan: transform.pan,
+ zoom: transform.zoom,
+ ...(databases[database].hasEnums && { enums }),
+ ...(databases[database].hasTypes && { types }),
+ };
+ try {
+ await extensions.cloudSave(cloudPayload, { isNew });
+ if (isNew) {
+ navigate(`/editor/diagrams/${targetId}`, { replace: true });
+ }
+ setSaveState(State.SAVED);
+ setLastSaved(new Date().toLocaleString());
+ } catch (err) {
+ console.warn("cloud autosave failed:", err);
+ if (err?.response?.status === 402) {
+ setSaveState(State.NONE);
+ navigate("/checkout?tier=solo_pro");
+ return;
+ }
+ setSaveState(State.ERROR);
+ }
+ return;
+ }
+
if (isTemplate || (!loadedDiagramId && !isTemplate && !isDiagram)) {
const diagramId = crypto.randomUUID();
await db.diagrams
@@ -140,6 +190,8 @@ export default function WorkSpace() {
});
}
}, [
+ cloudOnly,
+ extensions,
searchParams,
setSearchParams,
tables,
@@ -150,6 +202,7 @@ export default function WorkSpace() {
title,
transform,
setSaveState,
+ setLastSaved,
database,
enums,
gistId,
@@ -219,10 +272,17 @@ export default function WorkSpace() {
};
const loadDiagram = async (id) => {
- const diagram = await db.diagrams.where("diagramId").equals(id).first();
+ const diagram =
+ typeof extensions.cloudLoad === "function"
+ ? await extensions.cloudLoad(id)
+ : await db.diagrams.where("diagramId").equals(id).first();
if (!diagram) return;
+ if (typeof diagram.canWrite === "boolean") {
+ setLayout((prev) => ({ ...prev, readOnly: !diagram.canWrite }));
+ }
+
if (diagram.database) {
setDatabase(diagram.database);
} else {
@@ -400,6 +460,7 @@ export default function WorkSpace() {
return;
}
}, [
+ extensions,
setTransform,
setRedoStack,
setUndoStack,
@@ -413,6 +474,7 @@ export default function WorkSpace() {
setEnums,
selectedDb,
setSaveState,
+ setLayout,
searchParams,
navigate,
isDiagram,
@@ -493,10 +555,11 @@ export default function WorkSpace() {
{layout.sidebar && (
<SidePanel resize={resize} setResize={setResize} width={width} />
)}
- <div className="relative w-full h-full overflow-hidden">
+ <div className="relative flex-1 min-w-0 h-full overflow-hidden">
<CanvasContextProvider className="h-full w-full">
<Canvas saveState={saveState} setSaveState={setSaveState} />
</CanvasContextProvider>
+ <Slot name="canvas-overlay" />
{layout.toolbar && (
<div
ref={setToolbarContainer}
@@ -526,6 +589,7 @@ export default function WorkSpace() {
</div>
)}
</div>
+ <Slot name="right-panel" />
</div>
<Modal
centered
diff --git a/src/context/AreasContext.jsx b/src/context/AreasContext.jsx
index 2e18c1c2..d16064e2 100644
--- a/src/context/AreasContext.jsx
+++ b/src/context/AreasContext.jsx
@@ -2,7 +2,7 @@ import { Toast } from "@douyinfe/semi-ui";
import { createContext, useState } from "react";
import { useTranslation } from "react-i18next";
import { Action, ObjectType, defaultBlue } from "../data/constants";
-import { useSelect, useTransform, useUndoRedo } from "../hooks";
+import { useSelect, useTransform, useUndoRedo, useCollab } from "../hooks";
export const AreasContext = createContext(null);
@@ -12,8 +12,11 @@ export default function AreasContextProvider({ children }) {
const { transform } = useTransform();
const { selectedElement, setSelectedElement } = useSelect();
const { setUndoStack, setRedoStack } = useUndoRedo();
+ const { emitDelta, isApplyingRemoteRef } = useCollab();
+ const shouldEmit = () => !isApplyingRemoteRef?.current;
const addArea = (data, addToHistory = true) => {
+ let created = data;
if (data) {
setAreas((prev) => {
const temp = prev.slice();
@@ -23,19 +26,17 @@ export default function AreasContextProvider({ children }) {
} else {
const width = 200;
const height = 200;
- setAreas((prev) => [
- ...prev,
- {
- id: prev.length,
- name: `area_${prev.length}`,
- x: transform.pan.x - width / 2,
- y: transform.pan.y - height / 2,
- width,
- height,
- color: defaultBlue,
- locked: false,
- },
- ]);
+ created = {
+ id: areas.length,
+ name: `area_${areas.length}`,
+ x: transform.pan.x - width / 2,
+ y: transform.pan.y - height / 2,
+ width,
+ height,
+ color: defaultBlue,
+ locked: false,
+ };
+ setAreas((prev) => [...prev, { ...created, id: prev.length }]);
}
if (addToHistory) {
setUndoStack((prev) => [
@@ -48,6 +49,14 @@ export default function AreasContextProvider({ children }) {
]);
setRedoStack([]);
}
+ if (shouldEmit() && created) {
+ emitDelta({
+ target: "area",
+ action: "create",
+ entityId: created.id,
+ data: [created],
+ });
+ }
};
const deleteArea = (id, addToHistory = true) => {
@@ -75,6 +84,14 @@ export default function AreasContextProvider({ children }) {
open: false,
}));
}
+ if (shouldEmit()) {
+ emitDelta({
+ target: "area",
+ action: "delete",
+ entityId: id,
+ data: [id],
+ });
+ }
};
const updateArea = (id, values) => {
@@ -89,6 +106,14 @@ export default function AreasContextProvider({ children }) {
return t;
}),
);
+ if (shouldEmit()) {
+ emitDelta({
+ target: "area",
+ action: "update",
+ entityId: id,
+ data: [id, values],
+ });
+ }
};
return (
diff --git a/src/context/CollabContext.jsx b/src/context/CollabContext.jsx
new file mode 100644
index 00000000..21fe2afa
--- /dev/null
+++ b/src/context/CollabContext.jsx
@@ -0,0 +1,22 @@
+import { createContext, useMemo, useRef } from "react";
+
+export const CollabContext = createContext({
+ emitDelta: () => {},
+ emitAwareness: () => {},
+ isApplyingRemoteRef: { current: false },
+});
+
+export default function CollabContextProvider({ children }) {
+ const isApplyingRemoteRef = useRef(false);
+ const value = useMemo(
+ () => ({
+ emitDelta: () => {},
+ emitAwareness: () => {},
+ isApplyingRemoteRef,
+ }),
+ [],
+ );
+ return (
+ <CollabContext.Provider value={value}>{children}</CollabContext.Provider>
+ );
+}
diff --git a/src/context/DiagramContext.jsx b/src/context/DiagramContext.jsx
index 3b34a830..9632d889 100644
--- a/src/context/DiagramContext.jsx
+++ b/src/context/DiagramContext.jsx
@@ -1,6 +1,6 @@
-import { createContext, useState } from "react";
+import { createContext, useCallback, useState } from "react";
import { Action, DB, ObjectType, defaultBlue } from "../data/constants";
-import { useTransform, useUndoRedo, useSelect } from "../hooks";
+import { useTransform, useUndoRedo, useSelect, useCollab } from "../hooks";
import { Toast } from "@douyinfe/semi-ui";
import { useTranslation } from "react-i18next";
import { nanoid } from "nanoid";
@@ -9,12 +9,30 @@ export const DiagramContext = createContext(null);
export default function DiagramContextProvider({ children }) {
const { t } = useTranslation();
- const [database, setDatabase] = useState(DB.GENERIC);
+ const [database, setDatabaseRaw] = useState(DB.GENERIC);
const [tables, setTables] = useState([]);
const [relationships, setRelationships] = useState([]);
const { transform } = useTransform();
const { setUndoStack, setRedoStack } = useUndoRedo();
const { selectedElement, setSelectedElement } = useSelect();
+ const { emitDelta, isApplyingRemoteRef } = useCollab();
+
+ const shouldEmit = () => !isApplyingRemoteRef?.current;
+
+ const setDatabase = useCallback(
+ (next) => {
+ setDatabaseRaw(next);
+ if (!isApplyingRemoteRef?.current) {
+ emitDelta({
+ target: "database",
+ action: "update",
+ entityId: "database",
+ data: [next],
+ });
+ }
+ },
+ [emitDelta, isApplyingRemoteRef],
+ );
const addTable = (data, addToHistory = true) => {
const id = nanoid();
@@ -65,6 +83,15 @@ export default function DiagramContextProvider({ children }) {
]);
setRedoStack([]);
}
+ if (shouldEmit()) {
+ const created = data?.table ?? newTable;
+ emitDelta({
+ target: "table",
+ action: "create",
+ entityId: created.id,
+ data: [created],
+ });
+ }
};
const deleteTable = (id, addToHistory = true) => {
@@ -105,12 +132,28 @@ export default function DiagramContextProvider({ children }) {
open: false,
}));
}
+ if (shouldEmit()) {
+ emitDelta({
+ target: "table",
+ action: "delete",
+ entityId: id,
+ data: [id],
+ });
+ }
};
const updateTable = (id, updatedValues) => {
setTables((prev) =>
prev.map((t) => (t.id === id ? { ...t, ...updatedValues } : t)),
);
+ if (shouldEmit()) {
+ emitDelta({
+ target: "table",
+ action: "update",
+ entityId: id,
+ data: [id, updatedValues],
+ });
+ }
};
const updateField = (tid, fid, updatedValues) => {
@@ -127,6 +170,14 @@ export default function DiagramContextProvider({ children }) {
return table;
}),
);
+ if (shouldEmit()) {
+ emitDelta({
+ target: "table",
+ action: "update",
+ entityId: tid,
+ data: [tid, fid, updatedValues],
+ });
+ }
};
const deleteField = (field, tid, addToHistory = true) => {
@@ -200,6 +251,15 @@ export default function DiagramContextProvider({ children }) {
return temp;
});
}
+ if (shouldEmit()) {
+ const created = data?.relationship ?? data;
+ emitDelta({
+ target: "relationship",
+ action: "create",
+ entityId: created.id,
+ data: [created],
+ });
+ }
};
const deleteRelationship = (id, addToHistory = true) => {
@@ -222,6 +282,14 @@ export default function DiagramContextProvider({ children }) {
setRedoStack([]);
}
setRelationships((prev) => prev.filter((e) => e.id !== id));
+ if (shouldEmit()) {
+ emitDelta({
+ target: "relationship",
+ action: "delete",
+ entityId: id,
+ data: [id],
+ });
+ }
if (
selectedElement.element === ObjectType.RELATIONSHIP &&
selectedElement.id === id
@@ -239,6 +307,14 @@ export default function DiagramContextProvider({ children }) {
setRelationships((prev) =>
prev.map((t) => (t.id === id ? { ...t, ...updatedValues } : t)),
);
+ if (shouldEmit()) {
+ emitDelta({
+ target: "relationship",
+ action: "update",
+ entityId: id,
+ data: [id, updatedValues],
+ });
+ }
};
return (
diff --git a/src/context/EnumsContext.jsx b/src/context/EnumsContext.jsx
index a2ddf75a..60ed368c 100644
--- a/src/context/EnumsContext.jsx
+++ b/src/context/EnumsContext.jsx
@@ -1,8 +1,8 @@
-import { createContext, useState } from "react";
+import { createContext, useEffect, useRef, useState } from "react";
import { Action, ObjectType } from "../data/constants";
import { Toast } from "@douyinfe/semi-ui";
import { useTranslation } from "react-i18next";
-import { useUndoRedo } from "../hooks";
+import { useUndoRedo, useCollab } from "../hooks";
import { nanoid } from "nanoid";
export const EnumsContext = createContext(null);
@@ -11,6 +11,23 @@ export default function EnumsContextProvider({ children }) {
const { t } = useTranslation();
const [enums, setEnums] = useState([]);
const { setUndoStack, setRedoStack } = useUndoRedo();
+ const { emitDelta, isApplyingRemoteRef } = useCollab();
+ const firstRun = useRef(true);
+
+ useEffect(() => {
+ if (firstRun.current) {
+ firstRun.current = false;
+ return;
+ }
+ if (isApplyingRemoteRef?.current) return;
+ emitDelta({
+ target: "enums",
+ action: "update",
+ entityId: "enums",
+ data: [enums],
+ });
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [enums]);
const addEnum = (data, addToHistory = true) => {
const newEnum = {
diff --git a/src/context/ExtensionsContext.jsx b/src/context/ExtensionsContext.jsx
new file mode 100644
index 00000000..fedbf7bf
--- /dev/null
+++ b/src/context/ExtensionsContext.jsx
@@ -0,0 +1,14 @@
+import { createContext, useContext } from "react";
+
+const ExtensionsContext = createContext({});
+
+export function useExtensions() {
+ return useContext(ExtensionsContext);
+}
+
+export function Slot({ name }) {
+ const extensions = useExtensions();
+ return extensions[name] ?? null;
+}
+
+export default ExtensionsContext;
diff --git a/src/context/NotesContext.jsx b/src/context/NotesContext.jsx
index ce5bbae2..9b584922 100644
--- a/src/context/NotesContext.jsx
+++ b/src/context/NotesContext.jsx
@@ -5,7 +5,7 @@ import {
defaultNoteTheme,
noteWidth,
} from "../data/constants";
-import { useUndoRedo, useTransform, useSelect } from "../hooks";
+import { useUndoRedo, useTransform, useSelect, useCollab } from "../hooks";
import { Toast } from "@douyinfe/semi-ui";
import { useTranslation } from "react-i18next";
@@ -17,8 +17,11 @@ export default function NotesContextProvider({ children }) {
const { transform } = useTransform();
const { setUndoStack, setRedoStack } = useUndoRedo();
const { selectedElement, setSelectedElement } = useSelect();
+ const { emitDelta, isApplyingRemoteRef } = useCollab();
+ const shouldEmit = () => !isApplyingRemoteRef?.current;
const addNote = (data, addToHistory = true) => {
+ let created = data;
if (data) {
setNotes((prev) => {
const temp = prev.slice();
@@ -27,20 +30,18 @@ export default function NotesContextProvider({ children }) {
});
} else {
const height = 88;
- setNotes((prev) => [
- ...prev,
- {
- id: prev.length,
- x: transform.pan.x,
- y: transform.pan.y - height / 2,
- title: `note_${prev.length}`,
- content: "",
- locked: false,
- color: defaultNoteTheme,
- height,
- width: noteWidth,
- },
- ]);
+ created = {
+ id: notes.length,
+ x: transform.pan.x,
+ y: transform.pan.y - height / 2,
+ title: `note_${notes.length}`,
+ content: "",
+ locked: false,
+ color: defaultNoteTheme,
+ height,
+ width: noteWidth,
+ };
+ setNotes((prev) => [...prev, { ...created, id: prev.length }]);
}
if (addToHistory) {
setUndoStack((prev) => [
@@ -53,6 +54,14 @@ export default function NotesContextProvider({ children }) {
]);
setRedoStack([]);
}
+ if (shouldEmit() && created) {
+ emitDelta({
+ target: "note",
+ action: "create",
+ entityId: created.id,
+ data: [created],
+ });
+ }
};
const deleteNote = (id, addToHistory = true) => {
@@ -80,21 +89,41 @@ export default function NotesContextProvider({ children }) {
open: false,
}));
}
+ if (shouldEmit()) {
+ emitDelta({
+ target: "note",
+ action: "delete",
+ entityId: id,
+ data: [id],
+ });
+ }
};
- const updateNote = useCallback((id, values) => {
- setNotes((prev) =>
- prev.map((t) => {
- if (t.id === id) {
- return {
- ...t,
- ...values,
- };
- }
- return t;
- }),
- );
- }, []);
+ const updateNote = useCallback(
+ (id, values) => {
+ setNotes((prev) =>
+ prev.map((t) => {
+ if (t.id === id) {
+ return {
+ ...t,
+ ...values,
+ };
+ }
+ return t;
+ }),
+ );
+ if (shouldEmit()) {
+ emitDelta({
+ target: "note",
+ action: "update",
+ entityId: id,
+ data: [id, values],
+ });
+ }
+ },
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ [emitDelta],
+ );
return (
<NotesContext.Provider
diff --git a/src/context/SettingsContext.jsx b/src/context/SettingsContext.jsx
index 33919841..42268022 100644
--- a/src/context/SettingsContext.jsx
+++ b/src/context/SettingsContext.jsx
@@ -18,7 +18,10 @@ const defaultSettings = {
showComments: false,
};
-export const SettingsContext = createContext(defaultSettings);
+export const SettingsContext = createContext({
+ settings: defaultSettings,
+ setSettings: () => {},
+});
export default function SettingsContextProvider({ children }) {
const [searchParams] = useSearchParams();
diff --git a/src/context/TypesContext.jsx b/src/context/TypesContext.jsx
index 4eb4ce8d..a053c786 100644
--- a/src/context/TypesContext.jsx
+++ b/src/context/TypesContext.jsx
@@ -1,6 +1,6 @@
-import { createContext, useState } from "react";
+import { createContext, useEffect, useRef, useState } from "react";
import { Action, ObjectType } from "../data/constants";
-import { useUndoRedo } from "../hooks";
+import { useUndoRedo, useCollab } from "../hooks";
import { Toast } from "@douyinfe/semi-ui";
import { useTranslation } from "react-i18next";
import { nanoid } from "nanoid";
@@ -11,6 +11,23 @@ export default function TypesContextProvider({ children }) {
const { t } = useTranslation();
const [types, setTypes] = useState([]);
const { setUndoStack, setRedoStack } = useUndoRedo();
+ const { emitDelta, isApplyingRemoteRef } = useCollab();
+ const firstRun = useRef(true);
+
+ useEffect(() => {
+ if (firstRun.current) {
+ firstRun.current = false;
+ return;
+ }
+ if (isApplyingRemoteRef?.current) return;
+ emitDelta({
+ target: "types",
+ action: "update",
+ entityId: "types",
+ data: [types],
+ });
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [types]);
const addType = (data, addToHistory = true) => {
const id = nanoid();
diff --git a/src/hooks/index.js b/src/hooks/index.js
index b90bbb53..c80b631a 100644
--- a/src/hooks/index.js
+++ b/src/hooks/index.js
@@ -13,3 +13,4 @@ export { default as useUndoRedo } from "./useUndoRedo";
export { default as useEnums } from "./useEnums";
export { default as useThemedPage } from "./useThemedPage";
export { default as useNavigateWithParams } from "./useNavigateWithParams";
+export { default as useCollab } from "./useCollab";
diff --git a/src/hooks/useCollab.js b/src/hooks/useCollab.js
new file mode 100644
index 00000000..f6169811
--- /dev/null
+++ b/src/hooks/useCollab.js
@@ -0,0 +1,6 @@
+import { useContext } from "react";
+import { CollabContext } from "../context/CollabContext";
+
+export default function useCollab() {
+ return useContext(CollabContext);
+}
diff --git a/src/pages/BugReport.jsx b/src/pages/BugReport.jsx
index 0e8969b3..66c3a6f3 100644
--- a/src/pages/BugReport.jsx
+++ b/src/pages/BugReport.jsx
@@ -12,7 +12,7 @@ import { CLEAR_EDITOR_COMMAND } from "lexical";
import { Link } from "react-router-dom";
import { socials } from "../data/socials";
import { send } from "../api/email";
-import { useSettings, useThemedPage } from "../hooks";
+import { useThemedPage } from "../hooks";
function Form({ theme }) {
const [editor] = useLexicalComposerContext();
@@ -124,9 +124,7 @@ function Form({ theme }) {
}
export default function BugReport() {
- const {
- settings: { mode: theme },
- } = useSettings();
+ const theme = localStorage.getItem("theme") || "light";
useEffect(() => {
document.title = "Report a bug | drawDB";
diff --git a/src/pages/Editor.jsx b/src/pages/Editor.jsx
index 7da3f0de..519e9c65 100644
--- a/src/pages/Editor.jsx
+++ b/src/pages/Editor.jsx
@@ -6,6 +6,7 @@ import SelectContextProvider from "../context/SelectContext";
import AreasContextProvider from "../context/AreasContext";
import NotesContextProvider from "../context/NotesContext";
import TypesContextProvider from "../context/TypesContext";
+import SettingsContextProvider from "../context/SettingsContext";
import SaveStateContextProvider from "../context/SaveStateContext";
import EnumsContextProvider from "../context/EnumsContext";
import WorkSpace from "../components/Workspace";
@@ -15,26 +16,28 @@ export default function Editor() {
useThemedPage();
return (
- <LayoutContextProvider>
- <TransformContextProvider>
- <UndoRedoContextProvider>
- <SelectContextProvider>
- <AreasContextProvider>
- <NotesContextProvider>
- <TypesContextProvider>
- <EnumsContextProvider>
- <TablesContextProvider>
- <SaveStateContextProvider>
- <WorkSpace />
- </SaveStateContextProvider>
- </TablesContextProvider>
- </EnumsContextProvider>
- </TypesContextProvider>
- </NotesContextProvider>
- </AreasContextProvider>
- </SelectContextProvider>
- </UndoRedoContextProvider>
- </TransformContextProvider>
- </LayoutContextProvider>
+ <SettingsContextProvider>
+ <LayoutContextProvider>
+ <TransformContextProvider>
+ <UndoRedoContextProvider>
+ <SelectContextProvider>
+ <AreasContextProvider>
+ <NotesContextProvider>
+ <TypesContextProvider>
+ <EnumsContextProvider>
+ <TablesContextProvider>
+ <SaveStateContextProvider>
+ <WorkSpace />
+ </SaveStateContextProvider>
+ </TablesContextProvider>
+ </EnumsContextProvider>
+ </TypesContextProvider>
+ </NotesContextProvider>
+ </AreasContextProvider>
+ </SelectContextProvider>
+ </UndoRedoContextProvider>
+ </TransformContextProvider>
+ </LayoutContextProvider>
+ </SettingsContextProvider>
);
}