Database diagrams editor that allows you to visualize and design your DB with a single query.
TypeScript databasedbdb-migrationeditorerdmariadbmssqlmysqlpostgresqlreactreact-flowschema-migrationssqlsqlitetypescriptvisualizationxyflow
clone template behavior (#306)
Guy Ben-Aharon48d712539037
diff --git a/src/lib/env.ts b/src/lib/env.tsindex 2baff8b8..95ec41b4 100644--- a/src/lib/env.ts+++ b/src/lib/env.ts@@ -1,3 +1,4 @@export const OPENAI_API_KEY: string = import.meta.env.VITE_OPENAI_API_KEY;export const IS_CHARTDB_IO: boolean =import.meta.env.VITE_IS_CHARTDB_IO === 'true';+export const APP_URL: string = import.meta.env.VITE_APP_URL;diff --git a/src/pages/clone-template-page/clone-template-page.tsx b/src/pages/clone-template-page/clone-template-page.tsxnew file mode 100644index 00000000..9b8a4283--- /dev/null+++ b/src/pages/clone-template-page/clone-template-page.tsx@@ -0,0 +1,62 @@+import { Spinner } from '@/components/spinner/spinner';+import React, { useCallback, useEffect } from 'react';+import { useLoaderData, useNavigate } from 'react-router-dom';+import type { TemplatePageLoaderData } from '../template-page/template-page';+import { convertTemplateToNewDiagram } from '@/templates-data/template-utils';+import type { Diagram } from '@/lib/domain/diagram';+import { useStorage } from '@/hooks/use-storage';+import { LocalConfigProvider } from '@/context/local-config-context/local-config-provider';+import { StorageProvider } from '@/context/storage-context/storage-provider';+import { ThemeProvider } from '@/context/theme-context/theme-provider';++export const CloneTemplateComponent: React.FC = () => {+ const navigate = useNavigate();+ const { addDiagram, deleteDiagram } = useStorage();+ const data = useLoaderData() as TemplatePageLoaderData;++ const template = data.template;++ const cloneTemplate = useCallback(async () => {+ if (!template) {+ return;+ }++ const diagram = convertTemplateToNewDiagram(template);++ await deleteDiagram(diagram.id);++ const now = new Date();+ const diagramToAdd: Diagram = {+ ...diagram,+ createdAt: now,+ updatedAt: now,+ };++ await addDiagram({ diagram: diagramToAdd });+ navigate(`/diagrams/${diagramToAdd.id}`);+ }, [addDiagram, deleteDiagram, navigate, template]);++ useEffect(() => {+ if (!template) {+ navigate('/templates');+ } else {+ cloneTemplate();+ }+ }, [template, navigate, cloneTemplate]);++ return (+ <section className="flex w-screen flex-col bg-background">+ <Spinner size={'large'} className="mt-20 text-pink-600" />+ </section>+ );+};++export const CloneTemplatePage: React.FC = () => (+ <LocalConfigProvider>+ <StorageProvider>+ <ThemeProvider>+ <CloneTemplateComponent />+ </ThemeProvider>+ </StorageProvider>+ </LocalConfigProvider>+);diff --git a/src/pages/editor-page/canvas/canvas-context-menu.tsx b/src/pages/editor-page/canvas/canvas-context-menu.tsxindex 92cbab03..15d3e713 100644--- a/src/pages/editor-page/canvas/canvas-context-menu.tsx+++ b/src/pages/editor-page/canvas/canvas-context-menu.tsx@@ -14,7 +14,7 @@ import { useTranslation } from 'react-i18next';export const CanvasContextMenu: React.FC<React.PropsWithChildren> = ({children,}) => {- const { createTable, filteredSchemas, schemas } = useChartDB();+ const { createTable, filteredSchemas, schemas, readonly } = useChartDB();const { openCreateRelationshipDialog, openTableSchemaDialog } = useDialog();const { screenToFlowPosition } = useReactFlow();const { t } = useTranslation();@@ -65,7 +65,7 @@ export const CanvasContextMenu: React.FC<React.PropsWithChildren> = ({openCreateRelationshipDialog();}, [openCreateRelationshipDialog]);- if (!isDesktop) {+ if (!isDesktop || readonly) {return <>{children}</>;}diff --git a/src/pages/editor-page/canvas/table-node/table-node-context-menu.tsx b/src/pages/editor-page/canvas/table-node/table-node-context-menu.tsxindex 884c1c32..c760295f 100644--- a/src/pages/editor-page/canvas/table-node/table-node-context-menu.tsx+++ b/src/pages/editor-page/canvas/table-node/table-node-context-menu.tsx@@ -18,7 +18,7 @@ export interface TableNodeContextMenuProps {export const TableNodeContextMenu: React.FC<React.PropsWithChildren<TableNodeContextMenuProps>> = ({ children, table }) => {- const { removeTable } = useChartDB();+ const { removeTable, readonly } = useChartDB();const { openTableFromSidebar } = useLayout();const { t } = useTranslation();const { isMd: isDesktop } = useBreakpoint('md');@@ -31,7 +31,7 @@ export const TableNodeContextMenu: React.FC<removeTable(table.id);}, [removeTable, table.id]);- if (!isDesktop) {+ if (!isDesktop || readonly) {return <>{children}</>;}return (diff --git a/src/pages/template-page/template-page.tsx b/src/pages/template-page/template-page.tsxindex 1bc963d7..10b84f33 100644--- a/src/pages/template-page/template-page.tsx+++ b/src/pages/template-page/template-page.tsx@@ -3,7 +3,6 @@ import ChartDBLogo from '@/assets/logo-light.png';import ChartDBDarkLogo from '@/assets/logo-dark.png';import { useTheme } from '@/hooks/use-theme';import { LocalConfigProvider } from '@/context/local-config-context/local-config-provider';-import { StorageProvider } from '@/context/storage-context/storage-provider';import { ThemeProvider } from '@/context/theme-context/theme-provider';import { Button } from '@/components/button/button';import { CloudDownload } from 'lucide-react';@@ -31,17 +30,14 @@ import { Badge } from '@/components/badge/badge';import { Canvas } from '../editor-page/canvas/canvas';import { ReactFlowProvider } from '@xyflow/react';import { ChartDBProvider } from '@/context/chartdb-context/chartdb-provider';-import { convertTemplateToNewDiagram } from '@/templates-data/template-utils';-import { useStorage } from '@/hooks/use-storage';-import type { Diagram } from '@/lib/domain/diagram';import { Helmet } from 'react-helmet-async';+import { APP_URL } from '@/lib/env';export interface TemplatePageLoaderData {template: Template | undefined;}const TemplatePageComponent: React.FC = () => {- const { addDiagram } = useStorage();const { templateSlug } = useParams<{ templateSlug: string }>();const navigate = useNavigate();const data = useLoaderData() as TemplatePageLoaderData;@@ -57,22 +53,12 @@ const TemplatePageComponent: React.FC = () => {const { effectiveTheme } = useTheme();const cloneTemplate = useCallback(async () => {- if (!template) {- return;+ if (APP_URL) {+ window.location.href = `${APP_URL}/templates/clone/${templateSlug}`;+ } else {+ navigate(`/templates/clone/${templateSlug}`);}-- const diagram = convertTemplateToNewDiagram(template);-- const now = new Date();- const diagramToAdd: Diagram = {- ...diagram,- createdAt: now,- updatedAt: now,- };-- await addDiagram({ diagram: diagramToAdd });- navigate(`/diagrams/${diagramToAdd.id}`);- }, [addDiagram, navigate, template]);+ }, [navigate, templateSlug]);return (<>@@ -242,12 +228,10 @@ const TemplatePageComponent: React.FC = () => {export const TemplatePage: React.FC = () => (<LocalConfigProvider>- <StorageProvider>- <ThemeProvider>- <ReactFlowProvider>- <TemplatePageComponent />- </ReactFlowProvider>- </ThemeProvider>- </StorageProvider>+ <ThemeProvider>+ <ReactFlowProvider>+ <TemplatePageComponent />+ </ReactFlowProvider>+ </ThemeProvider></LocalConfigProvider>);diff --git a/src/router.tsx b/src/router.tsxindex ae87e03f..87c454ce 100644--- a/src/router.tsx+++ b/src/router.tsx@@ -85,6 +85,28 @@ const routes: RouteObject[] = [};},},+ {+ id: 'templates_load',+ path: 'templates/clone/:templateSlug',+ async lazy() {+ const { CloneTemplatePage } = await import(+ './pages/clone-template-page/clone-template-page'+ );+ return {+ element: <CloneTemplatePage />,+ };+ },+ loader: async ({ params }) => {+ const { templates } = await import(+ './templates-data/templates-data'+ );+ return {+ template: templates.find(+ (template) => template.slug === params.templateSlug+ ),+ };+ },+ },{path: '*',async lazy() {diff --git a/src/templates-data/template-utils.ts b/src/templates-data/template-utils.tsindex a9716a2b..17c37ec0 100644--- a/src/templates-data/template-utils.ts+++ b/src/templates-data/template-utils.ts@@ -1,6 +1,6 @@import type { Diagram } from '@/lib/domain/diagram';import type { Template } from './templates-data';-import { generateDiagramId, generateId } from '@/lib/utils';+import { generateId } from '@/lib/utils';import type { DBTable } from '@/lib/domain/db-table';import type { DBField } from '@/lib/domain/db-field';import type { DBIndex } from '@/lib/domain/db-index';@@ -8,7 +8,8 @@ import type { DBRelationship } from '@/lib/domain/db-relationship';import type { DBDependency } from '@/lib/domain/db-dependency';export const convertTemplateToNewDiagram = (template: Template): Diagram => {- const diagramId = generateDiagramId();+ // const diagramId = generateDiagramId();+ const diagramId = template.diagram.id;const idsMap = new Map<string, string>();template.diagram.tables?.forEach((table) => {