import { RefObject, useEffect } from 'react'; import { NoteBodyEditorRef, OnChangeEvent, ScrollOptionTypes } from './types'; import editorCommandDeclarations, { enabledCondition } from '../editorCommandDeclarations'; import CommandService, { CommandDeclaration, CommandRuntime, CommandContext, RegisteredRuntime } from '@joplin/lib/services/CommandService'; import time from '@joplin/lib/time'; import { reg } from '@joplin/lib/registry'; import getWindowCommandPriority from './getWindowCommandPriority'; const commandsWithDependencies = [ require('../commands/showLocalSearch'), require('../commands/focusElementNoteTitle'), require('../commands/focusElementNoteBody'), require('../commands/pasteAsText'), ]; type OnBodyChange = (event: OnChangeEvent)=> void; interface HookDependencies { // eslint-disable-next-line @typescript-eslint/ban-types -- Old code before rule was applied setShowLocalSearch: Function; // eslint-disable-next-line @typescript-eslint/ban-types -- Old code before rule was applied dispatch: Function; // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied noteSearchBarRef: any; editorRef: RefObject; titleInputRef: RefObject; onBodyChange: OnBodyChange; containerRef: RefObject; } function editorCommandRuntime( declaration: CommandDeclaration, editorRef: RefObject, onBodyChange: OnBodyChange, ): CommandRuntime { return { // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied execute: async (_context: CommandContext, ...args: any[]) => { if (!editorRef.current) { reg.logger().warn('Received command, but editor is gone', declaration.name); return; } if (!editorRef.current.execCommand) { reg.logger().warn('Received command, but editor cannot execute commands', declaration.name); return; } if (declaration.name === 'insertDateTime') { return editorRef.current.execCommand({ name: 'insertText', value: time.formatMsToLocal(new Date().getTime()), }); } else if (declaration.name === 'scrollToHash') { return editorRef.current.scrollTo({ type: ScrollOptionTypes.Hash, value: args[0], }); } else if (declaration.name === 'editor.setText') { onBodyChange({ content: args[0], changeId: 0 }); } else { return editorRef.current.execCommand({ name: declaration.name, value: args[0], }); } }, // We disable the editor commands whenever a modal dialog is visible, // otherwise the user might type something in a dialog and accidentally // change something in the editor. However, we still enable them for // GotoAnything so that it's possible to type eg `textBold` and bold the // currently selected text. // // https://github.com/laurent22/joplin/issues/5707 enabledCondition: enabledCondition(declaration.name), }; } export default function useWindowCommandHandler(dependencies: HookDependencies) { const { setShowLocalSearch, noteSearchBarRef, editorRef, titleInputRef, onBodyChange, containerRef } = dependencies; useEffect(() => { const getRuntimePriority = () => getWindowCommandPriority(containerRef); const deregisterCallbacks: RegisteredRuntime[] = []; for (const declaration of editorCommandDeclarations) { const runtime = editorCommandRuntime(declaration, editorRef, onBodyChange); deregisterCallbacks.push(CommandService.instance().registerRuntime( declaration.name, { ...runtime, getPriority: getRuntimePriority }, true, )); } const dependencies = { editorRef, setShowLocalSearch, noteSearchBarRef, titleInputRef, }; for (const command of commandsWithDependencies) { const runtime = command.runtime(dependencies); deregisterCallbacks.push(CommandService.instance().registerRuntime( command.declaration.name, { ...runtime, getPriority: getRuntimePriority }, true, )); } return () => { for (const runtime of deregisterCallbacks) { runtime.deregister(); } }; }, [editorRef, setShowLocalSearch, noteSearchBarRef, titleInputRef, onBodyChange, containerRef]); }