Add hooks to alter Mosaico plugins

CRM/Mosaico/Page/Editor.php

@@ -14,6 +14,7 @@ public function run() {
       $this->createMosaicoConfig(),
       defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0
     ));
+    $smarty->assign('mosaicoPlugins', $this->getMosaicoPlugins());
     echo $smarty->fetch(self::getTemplateFileName());
     CRM_Utils_System::civiExit();
   }
@@ -152,4 +153,26 @@ protected function getMaxFileSize() {
     return (int) min($iniVal, $settingVal);
   }
 
+  /**
+   * Gets the plugins for `Mosaico.init()`.
+   * 
+   * @return array
+   */
+  public function getMosaicoPlugins() {
+    $plugins = [];
+
+    // Allow plugins to be added by a hook.
+    if (class_exists('\Civi\Core\Event\GenericHookEvent')) {
+      \Civi::dispatcher()->dispatch('hook_civicrm_mosaicoPlugin',
+        \Civi\Core\Event\GenericHookEvent::create([
+          'plugins' => &$plugins,
+        ])
+      );
+    }
+
+    $plugins = '[ ' . implode(',', $plugins) . ' ]';
+
+    return $plugins;
+  }
+
 }

docs/api.md

@@ -102,4 +102,35 @@ function campaignadv_civicrm_mosaicoScriptUrlsAlter(&$scriptUrls) {
   $url = CRM_Utils_System::url('civicrm/campaignadv/mosaico-js', '', TRUE, NULL, NULL, NULL, NULL);
   $scriptUrls[] = $url;
 }
-```
+```
+
+## hook_civicrm_mosaicoPlugin(&$plugins)
+
+This hook can be implemented to add custom JS plugins to the Mosaico object during initialization, see [here](https://github.com/voidlabs/mosaico/wiki/Mosaico-Plugins) on how plugins work in Mosaico.
+
+Example usage:
+```
+/**
+ * Implements hook_civicrm_mosaicoPlugin().
+ */
+function example_civicrm_mosaicoPlugin(&$plugins) {
+    $plugins[] = _example_alert_plugin();
+}
+
+/**
+ * Example plugin to display alert on init and dispose.
+ */  
+function _example_alert_plugin(){
+    $plugin = <<< JS
+        function(vm) {
+            alert("test-plugin");
+            return {
+                    init: function(vm){alert("init");}, 
+                    dispose:  function(vm){alert("dispose");}
+                }  
+        }
+    JS;
+
+    return $plugin;
+}
+```

templates/CRM/Mosaico/Page/Editor.tpl

@@ -23,7 +23,7 @@
         return;
       }
 
-      var plugins;
+      var plugins = {/literal}{$mosaicoPlugins}{literal};
       // A basic plugin that expose the "viewModel" object as a global variable.
       // plugins = [function(vm) {window.viewModel = vm;}];
       var config = {/literal}{$mosaicoConfig}{literal};

templates/CRM/Mosaico/Page/EditorIframe.tpl

@@ -22,7 +22,7 @@
         return;
       }
 
-      var plugins = [];
+      var plugins = {/literal}{$mosaicoPlugins}{literal};
       var config = {/literal}{$mosaicoConfig}{literal};
 
       window.addEventListener('beforeunload', function(e) {