@antelopejs/dms-database 0.0.14 → 0.1.1

package/frontend-vue/app/config/shortcuts-registry.ts

@@ -0,0 +1,65 @@
+// The module's keyboard shortcuts, listed on the dashboard's Shortcuts
+// settings page (D-17); the components bind them themselves.
+
+interface ShortcutMetadata {
+	key: string[]
+	descriptionKey: string
+	component: string
+}
+
+interface ComponentShortcuts {
+	component: string
+	shortcuts: ShortcutMetadata[]
+}
+
+const META = '$keyboard.meta'
+const SHIFT = '$keyboard.shift'
+
+function group(
+	component: string,
+	entries: [string[], string][],
+): ComponentShortcuts {
+	return {
+		component,
+		shortcuts: entries.map(([key, description]) => ({
+			key,
+			descriptionKey: `$dms_database.shortcuts.${description}`,
+			component,
+		})),
+	}
+}
+
+export default [
+	group('$dms_database.shortcuts.data_browser', [
+		[['T'], 'find_table'],
+		[[META, '/'], 'search_rows'],
+		[['R'], 'refresh'],
+		[['$keyboard.enter'], 'edit_cell'],
+		[['$keyboard.space'], 'open_row'],
+		[['J'], 'next_row'],
+		[['K'], 'previous_row'],
+		[[META, 'S'], 'review_save'],
+	]),
+	group('$dms_database.shortcuts.schemas', [
+		[['/'], 'find_table_or_column'],
+		[['J'], 'next_table'],
+		[['K'], 'previous_table'],
+	]),
+	group('$dms_database.shortcuts.diagram', [
+		[['F'], 'find_table'],
+		[['N'], 'add_note'],
+		[['V'], 'select'],
+		[['H'], 'pan'],
+		[['1'], 'fit'],
+		[['0'], 'reset_zoom'],
+		[[META, 'Z'], 'undo'],
+		[[META, SHIFT, 'Z'], 'redo'],
+		[[META, 'Y'], 'redo'],
+		[['$keyboard.escape'], 'step_back'],
+	]),
+	group('$dms_database.shortcuts.query_console', [
+		[[META, '$keyboard.enter'], 'run'],
+		[[META, 'S'], 'save'],
+		[['Ctrl', '$keyboard.space'], 'complete'],
+	]),
+] satisfies ComponentShortcuts[]

package/frontend-vue/dms.frontend.ts

@@ -5,10 +5,13 @@ interface VueModule {
 	default: Component
 }
 
+// Every component is addressed by name from the backend (`CustomComponent`,
+// drawer targets), so the whole directory is registered: `DataBrowser.vue`
+// resolves as `DmsDatabaseDataBrowser`.
 const components = import.meta.glob<VueModule>('./app/components/**/*.vue')
-const pages = import.meta.glob<VueModule>('./app/custom-pages/**/*.vue')
 
 const frontendModule: DmsFrontendModule = {
+	componentPrefix: 'DmsDatabase',
 	setup(sdk) {
 		for (const [path, loader] of Object.entries(components).sort()) {
 			const name = path
@@ -16,22 +19,10 @@ const frontendModule: DmsFrontendModule = {
 				.at(-1)!
 				.replace(/\.vue$/, '')
 			sdk.registerComponent(
-				`DmsDatabase${name}`,
+				name,
 				defineAsyncComponent(async () => (await loader()).default),
 			)
 		}
-		for (const [path, loader] of Object.entries(pages).sort()) {
-			const name = path.replace('./app/custom-pages/', '').replace(/\.vue$/, '')
-			const component = defineAsyncComponent(
-				async () => (await loader()).default,
-			)
-			const componentName = name
-				.split('/')
-				.map((part) => part[0].toUpperCase() + part.slice(1))
-				.join('')
-			sdk.registerPage(name, component, loader)
-			sdk.registerComponent(`Dms${componentName}`, component)
-		}
 	},
 }