Skip to content

Database diagrams editor that allows you to visualize and design your DB with a single query.

fix(empty-state): show diff buttons on import-dbml when triggered by empty (#574)

Jonathan Fishner48342471ac23
diff --git a/src/context/dialog-context/dialog-context.tsx b/src/context/dialog-context/dialog-context.tsx
index 3d103f13..def7a6f1 100644
--- a/src/context/dialog-context/dialog-context.tsx
+++ b/src/context/dialog-context/dialog-context.tsx
@@ -7,6 +7,7 @@ import type { ExportImageDialogProps } from '@/dialogs/export-image-dialog/expor
import type { ExportDiagramDialogProps } from '@/dialogs/export-diagram-dialog/export-diagram-dialog';
import type { ImportDiagramDialogProps } from '@/dialogs/import-diagram-dialog/import-diagram-dialog';
import type { CreateRelationshipDialogProps } from '@/dialogs/create-relationship-dialog/create-relationship-dialog';
+import type { ImportDBMLDialogProps } from '@/dialogs/import-dbml-dialog/import-dbml-dialog';
export interface DialogContext {
// Create diagram dialog
@@ -66,7 +67,9 @@ export interface DialogContext {
closeImportDiagramDialog: () => void;
// Import DBML dialog
- openImportDBMLDialog: () => void;
+ openImportDBMLDialog: (
+ params?: Omit<ImportDBMLDialogProps, 'dialog'>
+ ) => void;
closeImportDBMLDialog: () => void;
}
diff --git a/src/context/dialog-context/dialog-provider.tsx b/src/context/dialog-context/dialog-provider.tsx
index 37dab67a..b0d8c60f 100644
--- a/src/context/dialog-context/dialog-provider.tsx
+++ b/src/context/dialog-context/dialog-provider.tsx
@@ -19,6 +19,7 @@ import { ExportImageDialog } from '@/dialogs/export-image-dialog/export-image-di
import { ExportDiagramDialog } from '@/dialogs/export-diagram-dialog/export-diagram-dialog';
import { ImportDiagramDialog } from '@/dialogs/import-diagram-dialog/import-diagram-dialog';
import { BuckleDialog } from '@/dialogs/buckle-dialog/buckle-dialog';
+import type { ImportDBMLDialogProps } from '@/dialogs/import-dbml-dialog/import-dbml-dialog';
import { ImportDBMLDialog } from '@/dialogs/import-dbml-dialog/import-dbml-dialog';
export const DialogProvider: React.FC<React.PropsWithChildren> = ({
@@ -111,6 +112,8 @@ export const DialogProvider: React.FC<React.PropsWithChildren> = ({
// Import DBML dialog
const [openImportDBMLDialog, setOpenImportDBMLDialog] = useState(false);
+ const [importDBMLDialogParams, setImportDBMLDialogParams] =
+ useState<Omit<ImportDBMLDialogProps, 'dialog'>>();
return (
<dialogContext.Provider
@@ -142,7 +145,10 @@ export const DialogProvider: React.FC<React.PropsWithChildren> = ({
openImportDiagramDialog: () => setOpenImportDiagramDialog(true),
closeImportDiagramDialog: () =>
setOpenImportDiagramDialog(false),
- openImportDBMLDialog: () => setOpenImportDBMLDialog(true),
+ openImportDBMLDialog: (params) => {
+ setImportDBMLDialogParams(params);
+ setOpenImportDBMLDialog(true);
+ },
closeImportDBMLDialog: () => setOpenImportDBMLDialog(false),
}}
>
@@ -173,7 +179,10 @@ export const DialogProvider: React.FC<React.PropsWithChildren> = ({
<ExportDiagramDialog dialog={{ open: openExportDiagramDialog }} />
<ImportDiagramDialog dialog={{ open: openImportDiagramDialog }} />
<BuckleDialog dialog={{ open: openBuckleDialog }} />
- <ImportDBMLDialog dialog={{ open: openImportDBMLDialog }} />
+ <ImportDBMLDialog
+ dialog={{ open: openImportDBMLDialog }}
+ {...importDBMLDialogParams}
+ />
</dialogContext.Provider>
);
};
diff --git a/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx b/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
index 93795801..9910bb6b 100644
--- a/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
+++ b/src/dialogs/create-diagram-dialog/create-diagram-dialog.tsx
@@ -28,7 +28,7 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
const [databaseType, setDatabaseType] = useState<DatabaseType>(
DatabaseType.GENERIC
);
- const { closeCreateDiagramDialog } = useDialog();
+ const { closeCreateDiagramDialog, openImportDBMLDialog } = useDialog();
const { updateConfig } = useConfig();
const [scriptResult, setScriptResult] = useState('');
const [databaseEdition, setDatabaseEdition] = useState<
@@ -104,6 +104,10 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
await updateConfig({ defaultDiagramId: diagram.id });
closeCreateDiagramDialog();
navigate(`/diagrams/${diagram.id}`);
+ setTimeout(
+ () => openImportDBMLDialog({ withCreateEmptyDiagram: true }),
+ 700
+ );
}, [
databaseType,
addDiagram,
@@ -112,6 +116,7 @@ export const CreateDiagramDialog: React.FC<CreateDiagramDialogProps> = ({
navigate,
updateConfig,
diagramNumber,
+ openImportDBMLDialog,
]);
return (
diff --git a/src/dialogs/import-dbml-dialog/import-dbml-dialog.tsx b/src/dialogs/import-dbml-dialog/import-dbml-dialog.tsx
index b2744f22..92117dbf 100644
--- a/src/dialogs/import-dbml-dialog/import-dbml-dialog.tsx
+++ b/src/dialogs/import-dbml-dialog/import-dbml-dialog.tsx
@@ -71,10 +71,13 @@ function parseDBMLError(error: unknown): DBMLError | null {
return null;
}
-export interface ImportDBMLDialogProps extends BaseDialogProps {}
+export interface ImportDBMLDialogProps extends BaseDialogProps {
+ withCreateEmptyDiagram?: boolean;
+}
export const ImportDBMLDialog: React.FC<ImportDBMLDialogProps> = ({
dialog,
+ withCreateEmptyDiagram,
}) => {
const { t } = useTranslation();
const initialDBML = `// Use DBML to define your database structure
@@ -331,7 +334,11 @@ Ref: comments.user_id > users.id // Each comment is written by one user`;
showClose
>
<DialogHeader>
- <DialogTitle>{t('import_dbml_dialog.title')}</DialogTitle>
+ <DialogTitle>
+ {withCreateEmptyDiagram
+ ? t('import_dbml_dialog.example_title')
+ : t('import_dbml_dialog.title')}
+ </DialogTitle>
<DialogDescription>
{t('import_dbml_dialog.description')}
</DialogDescription>
@@ -369,7 +376,9 @@ Ref: comments.user_id > users.id // Each comment is written by one user`;
<div className="flex items-center gap-4">
<DialogClose asChild>
<Button variant="secondary">
- {t('import_dbml_dialog.cancel')}
+ {withCreateEmptyDiagram
+ ? t('import_dbml_dialog.skip_and_empty')
+ : t('import_dbml_dialog.cancel')}
</Button>
</DialogClose>
{errorMessage ? (
@@ -389,7 +398,9 @@ Ref: comments.user_id > users.id // Each comment is written by one user`;
onClick={handleImport}
disabled={!dbmlContent.trim() || !!errorMessage}
>
- {t('import_dbml_dialog.import')}
+ {withCreateEmptyDiagram
+ ? t('import_dbml_dialog.show_example')
+ : t('import_dbml_dialog.import')}
</Button>
</div>
</DialogFooter>
diff --git a/src/i18n/locales/ar.ts b/src/i18n/locales/ar.ts
index 3ab4cb3b..b2a02444 100644
--- a/src/i18n/locales/ar.ts
+++ b/src/i18n/locales/ar.ts
@@ -378,9 +378,12 @@ export const ar: LanguageTranslation = {
import_dbml_dialog: {
// TODO: Translate
title: 'Import DBML',
+ example_title: 'Import Example DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/bn.ts b/src/i18n/locales/bn.ts
index ebb313de..e31a4271 100644
--- a/src/i18n/locales/bn.ts
+++ b/src/i18n/locales/bn.ts
@@ -381,10 +381,13 @@ export const bn: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/de.ts b/src/i18n/locales/de.ts
index fa8d87c4..d38b1a3d 100644
--- a/src/i18n/locales/de.ts
+++ b/src/i18n/locales/de.ts
@@ -384,10 +384,13 @@ export const de: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/en.ts b/src/i18n/locales/en.ts
index 74b2c7b9..b6870f72 100644
--- a/src/i18n/locales/en.ts
+++ b/src/i18n/locales/en.ts
@@ -376,10 +376,13 @@ export const en = {
},
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error importing DBML',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/es.ts b/src/i18n/locales/es.ts
index 2e9f6453..d7e8d273 100644
--- a/src/i18n/locales/es.ts
+++ b/src/i18n/locales/es.ts
@@ -383,10 +383,13 @@ export const es: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/fr.ts b/src/i18n/locales/fr.ts
index 3cd8a452..33a06a94 100644
--- a/src/i18n/locales/fr.ts
+++ b/src/i18n/locales/fr.ts
@@ -385,10 +385,13 @@ export const fr: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/gu.ts b/src/i18n/locales/gu.ts
index 28a17c4f..76b247f8 100644
--- a/src/i18n/locales/gu.ts
+++ b/src/i18n/locales/gu.ts
@@ -381,10 +381,13 @@ export const gu: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/hi.ts b/src/i18n/locales/hi.ts
index eb752344..bf50880d 100644
--- a/src/i18n/locales/hi.ts
+++ b/src/i18n/locales/hi.ts
@@ -385,10 +385,13 @@ export const hi: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/id_ID.ts b/src/i18n/locales/id_ID.ts
index 6b352050..ac36199c 100644
--- a/src/i18n/locales/id_ID.ts
+++ b/src/i18n/locales/id_ID.ts
@@ -379,10 +379,13 @@ export const id_ID: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/ja.ts b/src/i18n/locales/ja.ts
index 9ca48952..0748c995 100644
--- a/src/i18n/locales/ja.ts
+++ b/src/i18n/locales/ja.ts
@@ -388,10 +388,13 @@ export const ja: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/ko_KR.ts b/src/i18n/locales/ko_KR.ts
index a9b884c7..8737f989 100644
--- a/src/i18n/locales/ko_KR.ts
+++ b/src/i18n/locales/ko_KR.ts
@@ -377,10 +377,13 @@ export const ko_KR: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/mr.ts b/src/i18n/locales/mr.ts
index 3f52410b..d8b2da19 100644
--- a/src/i18n/locales/mr.ts
+++ b/src/i18n/locales/mr.ts
@@ -389,10 +389,13 @@ export const mr: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/ne.ts b/src/i18n/locales/ne.ts
index 6d6eb7a8..da60d65b 100644
--- a/src/i18n/locales/ne.ts
+++ b/src/i18n/locales/ne.ts
@@ -382,10 +382,13 @@ export const ne: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/pt_BR.ts b/src/i18n/locales/pt_BR.ts
index a3a1e6e6..95f5dd52 100644
--- a/src/i18n/locales/pt_BR.ts
+++ b/src/i18n/locales/pt_BR.ts
@@ -382,10 +382,13 @@ export const pt_BR: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/ru.ts b/src/i18n/locales/ru.ts
index f8746418..d0d24c97 100644
--- a/src/i18n/locales/ru.ts
+++ b/src/i18n/locales/ru.ts
@@ -378,10 +378,13 @@ export const ru: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/te.ts b/src/i18n/locales/te.ts
index f2962d12..4b154af9 100644
--- a/src/i18n/locales/te.ts
+++ b/src/i18n/locales/te.ts
@@ -385,10 +385,13 @@ export const te: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/tr.ts b/src/i18n/locales/tr.ts
index 24883b7e..59fb9489 100644
--- a/src/i18n/locales/tr.ts
+++ b/src/i18n/locales/tr.ts
@@ -372,10 +372,13 @@ export const tr: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/uk.ts b/src/i18n/locales/uk.ts
index 43f1b1e2..935e6a59 100644
--- a/src/i18n/locales/uk.ts
+++ b/src/i18n/locales/uk.ts
@@ -377,10 +377,13 @@ export const uk: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/vi.ts b/src/i18n/locales/vi.ts
index c466a42e..c63b5122 100644
--- a/src/i18n/locales/vi.ts
+++ b/src/i18n/locales/vi.ts
@@ -378,10 +378,13 @@ export const vi: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/zh_CN.ts b/src/i18n/locales/zh_CN.ts
index 79775c1f..df7b67a5 100644
--- a/src/i18n/locales/zh_CN.ts
+++ b/src/i18n/locales/zh_CN.ts
@@ -374,10 +374,13 @@ export const zh_CN: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',
diff --git a/src/i18n/locales/zh_TW.ts b/src/i18n/locales/zh_TW.ts
index 8f518fee..57fe4c92 100644
--- a/src/i18n/locales/zh_TW.ts
+++ b/src/i18n/locales/zh_TW.ts
@@ -373,10 +373,13 @@ export const zh_TW: LanguageTranslation = {
},
// TODO: Translate
import_dbml_dialog: {
+ example_title: 'Import Example DBML',
title: 'Import DBML',
description: 'Import a database schema from DBML format.',
import: 'Import',
cancel: 'Cancel',
+ skip_and_empty: 'Skip & Empty',
+ show_example: 'Show Example',
error: {
title: 'Error',
description: 'Failed to parse DBML. Please check the syntax.',