[IMP] Core: add execCustomCommand

odoo-dev · Jun 5, 2020 · d7ea373 · d7ea373
1 parent 281e77e
commit d7ea373
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 6 deletions.
diff --git a/packages/core/src/Dispatcher.ts b/packages/core/src/Dispatcher.ts
@@ -48,15 +48,17 @@ export class Dispatcher {
             // Call command handler.
             await command.handler(args);
 
-            // Call command hooks.
-            const hooks = this.commandHooks[commandId] || [];
-            const globalHooks = this.commandHooks['*'] || [];
-            for (const hookCallback of [...hooks, ...globalHooks]) {
-                await hookCallback(args, commandId);
-            }
+            await this._dispatchHooks(commandId, args);
         }
     }
 
+    /**
+     * Trigger the dispatcher for a custom command.
+     */
+    async dispatchCustom(): Promise<void> {
+        return this._dispatchHooks('@custom');
+    }
+
     /**
      * Register all handlers declared in a plugin, and match them with their
      * corresponding command.
@@ -82,4 +84,15 @@ export class Dispatcher {
         }
         this.commandHooks[id].push(hook);
     }
+
+    /**
+     * Dispatch to all registred `commandHooks`.
+     */
+    private async _dispatchHooks(commandId: CommandIdentifier, args?): Promise<void> {
+        const hooks = this.commandHooks[commandId] || [];
+        const globalHooks = this.commandHooks['*'] || [];
+        for (const hookCallback of [...hooks, ...globalHooks]) {
+            await hookCallback(args, commandId);
+        }
+    }
 }
diff --git a/packages/core/src/JWEditor.ts b/packages/core/src/JWEditor.ts
@@ -280,6 +280,16 @@ export class JWEditor {
         await this.dispatcher.dispatch(commandName, params);
     }
 
+    /**
+     * Execute arbitrary code in `callback`, then dispatch the event.
+     */
+    async execCustomCommand<P extends JWPlugin, C extends Commands<P> = Commands<P>>(
+        callback: () => Promise<void>,
+    ): Promise<void> {
+        await callback();
+        await this.dispatcher.dispatchCustom();
+    }
+
     /**
      * Stop this editor instance.
      */

diff --git a/packages/core/test/JWeditor.test.ts b/packages/core/test/JWeditor.test.ts
@@ -2,6 +2,9 @@ import JWEditor, { Mode } from '../src/JWEditor';
 import { JWPlugin, JWPluginConfig } from '../src/JWPlugin';
 import { expect } from 'chai';
 import { ModeError } from '../../utils/src/errors';
+import { testEditor } from '../../utils/src/testUtils';
+import { BasicEditor } from '../../../bundles/BasicEditor';
+import { Layout } from '../../plugin-layout/src/Layout';
 
 describe('core', () => {
     describe('JWEditor', () => {
@@ -226,5 +229,23 @@ describe('core', () => {
                 });
             });
         });
+        describe('execCustomCommand', () => {
+            it('should execute a custom command and trigger plugins', async () => {
+                await testEditor(BasicEditor, {
+                    contentBefore: '<div>ab[]</div>',
+                    stepFunction: async editor => {
+                        await editor.execCustomCommand(async () => {
+                            const layout = editor.plugins.get(Layout);
+                            const domEngine = layout.engines.dom;
+                            domEngine.components
+                                .get('editable')[0]
+                                .firstLeaf()
+                                .remove();
+                        });
+                    },
+                    contentAfter: '<div>b[]</div>',
+                });
+            });
+        });
     });
 });