feat: add onTrayUpdate trigger to plugin system

Author: Ayideyia

frontend/src/constant/app.ts

@@ -84,12 +84,13 @@ export const DraggableOptions = {
 }
 
 export const PluginsTriggerOptions = [
-  { label: 'plugin.on::manual', value: PluginTrigger.OnManual },
   { label: 'plugin.on::startup', value: PluginTrigger.OnStartup },
   { label: 'plugin.on::ready', value: PluginTrigger.OnReady },
   { label: 'plugin.on::shutdown', value: PluginTrigger.OnShutdown },
+  { label: 'plugin.on::manual', value: PluginTrigger.OnManual },
   { label: 'plugin.on::generate', value: PluginTrigger.OnGenerate },
   { label: 'plugin.on::subscribe', value: PluginTrigger.OnSubscribe },
+  { label: 'plugin.on::tray::update', value: PluginTrigger.OnTrayUpdate },
   { label: 'plugin.on::before::core::start', value: PluginTrigger.OnBeforeCoreStart },
   { label: 'plugin.on::core::started', value: PluginTrigger.OnCoreStarted },
   { label: 'plugin.on::before::core::stop', value: PluginTrigger.OnBeforeCoreStop },

frontend/src/enums/app.ts

@@ -64,12 +64,14 @@ export enum PluginTrigger {
   OnCoreStopped = 'on::core::stopped',
   OnBeforeCoreStart = 'on::before::core::start',
   OnBeforeCoreStop = 'on::before::core::stop',
+  OnTrayUpdate = 'on::tray::update',
 }
 
 export enum PluginTriggerEvent {
   OnInstall = 'onInstall',
   OnUninstall = 'onUninstall',
   OnManual = 'onRun',
+  OnTrayUpdate = 'onTrayUpdate',
   OnSubscribe = 'onSubscribe',
   OnGenerate = 'onGenerate',
   OnStartup = 'onStartup',

frontend/src/lang/locale/en.ts

@@ -482,6 +482,7 @@ export default {
     'on::core::stopped': 'on::core::stopped',
     'on::before::core::start': 'on::before::core::start',
     'on::before::core::stop': 'on::before::core::stop',
+    'on::tray::update': 'on::tray::update',
     name: 'Name',
     version: 'Version',
     description: 'Description',

frontend/src/lang/locale/zh.ts

@@ -481,6 +481,7 @@ export default {
     'on::core::stopped': '核心停止后',
     'on::before::core::start': '核心启动前',
     'on::before::core::stop': '核心停止前',
+    'on::tray::update': '托盘更新时',
     name: '名称',
     version: '版本号',
     description: '描述',

frontend/src/stores/plugins.ts

@@ -18,7 +18,7 @@ import {
   asyncPool,
 } from '@/utils'
 
-import type { Plugin, Subscription } from '@/types/app'
+import type { Plugin, Subscription, TrayContent, MenuItem } from '@/types/app'
 
 const PluginsCache: Recordable<{ plugin: Plugin; code: string }> = {}
 
@@ -32,6 +32,10 @@ const PluginsTriggerMap: {
     fnName: PluginTriggerEvent.OnManual,
     observers: [],
   },
+  [PluginTrigger.OnTrayUpdate]: {
+    fnName: PluginTriggerEvent.OnTrayUpdate,
+    observers: [],
+  },
   [PluginTrigger.OnSubscribe]: {
     fnName: PluginTriggerEvent.OnSubscribe,
     observers: [],
@@ -125,7 +129,7 @@ export const usePluginsStore = defineStore('plugins', () => {
       configuration[key] = value
     }
     Object.assign(configuration, appSettingsStore.app.pluginSettings[plugin.id] ?? {})
-    return { ...plugin, ...configuration }
+    return deepClone({ ...plugin, ...configuration })
   }
 
   const isPluginUnavailable = (
@@ -465,6 +469,35 @@ export const usePluginsStore = defineStore('plugins', () => {
     }
   }
 
+  const onTrayUpdateTrigger = async (tray: TrayContent, menus: MenuItem[]) => {
+    const { fnName, observers } = PluginsTriggerMap[PluginTrigger.OnTrayUpdate]
+
+    let finalTray = tray
+    let finalMenus = menus
+    for (const observer of observers) {
+      const cache = PluginsCache[observer]
+
+      if (isPluginUnavailable(cache)) continue
+
+      const metadata = getPluginMetadata(cache.plugin)
+      try {
+        const fn = new window.AsyncFunction(
+          'Plugin',
+          'tray',
+          'menus',
+          `${cache.code}; return await ${fnName}(tray, menus)`,
+        )
+        const { tray, menus } = await fn(metadata, finalTray, finalMenus)
+        finalTray = tray
+        finalMenus = menus
+      } catch (error: any) {
+        throw `${cache.plugin.name} : ` + (error.message || error)
+      }
+    }
+
+    return [finalTray, finalMenus] as const
+  }
+
   const _watchDisabled = computed(() =>
     plugins.value
       .map((v) => v.disabled)
@@ -496,6 +529,7 @@ export const usePluginsStore = defineStore('plugins', () => {
     updatePlugins,
     getPluginById,
     reloadPlugin,
+    onTrayUpdateTrigger,
     onSubscribeTrigger,
     onGenerateTrigger,
     onStartupTrigger: () => noParamsTrigger(PluginTrigger.OnStartup),

frontend/src/utils/completion.ts

@@ -44,6 +44,15 @@ export const getCompletions = (pluginScope: any = undefined) => {
         detail: t('plugin.trigger') + ' ' + t('plugin.on::manual'),
       },
     ),
+    snippetCompletion(
+      `/* ${t('plugin.trigger') + ' ' + t('plugin.on::tray::update')} */\n` +
+        `const ${PluginTriggerEvent.OnTrayUpdate} = async (tray, menus) => {\n\t\${}\n\treturn { tray, menus }\n}`,
+      {
+        label: PluginTriggerEvent.OnTrayUpdate,
+        type: 'keyword',
+        detail: t('plugin.trigger') + ' ' + t('plugin.on::tray::update'),
+      },
+    ),
     snippetCompletion(
       `/* ${t('plugin.trigger') + ' ' + t('plugin.on::subscribe')} */\n` +
         `const ${PluginTriggerEvent.OnSubscribe} = async (proxies, subscription) => {\n\t\${}\n\treturn proxies\n}`,

frontend/src/utils/tray.ts

@@ -388,16 +388,21 @@ const getTrayMenus = () => {
     },
   ]
 
-  return generateUniqueEventsForMenu(trayMenus)
+  return trayMenus
 }
 
 export const updateTrayMenus = debounce(async () => {
   const trayMenus = getTrayMenus()
   const trayIcons = getTrayIcons()
+  const pluginsStore = usePluginsStore()
 
   const isDarwin = useEnvStore().env.os === 'darwin'
   const title = isDarwin ? '' : APP_TITLE
 
-  await UpdateTray({ icon: trayIcons, title, tooltip: APP_TITLE + ' ' + APP_VERSION })
-  await UpdateTrayMenus(trayMenus as any)
+  const tray = { icon: trayIcons, title, tooltip: APP_TITLE + ' ' + APP_VERSION }
+
+  const [finalTray, finalMenus] = await pluginsStore.onTrayUpdateTrigger(tray, trayMenus)
+
+  await UpdateTray(finalTray)
+  await UpdateTrayMenus(generateUniqueEventsForMenu(finalMenus) as any)
 }, 500)

frontend/src/views/PluginsView/components/PluginForm.vue

@@ -208,11 +208,15 @@ defineExpose({ modalSlots })
     </div>
     <div class="form-item">
       <div class="mr-8">{{ t('plugin.trigger') }}</div>
-      <CheckBox v-model="plugin.triggers" :options="PluginsTriggerOptions.slice(0, 6)" />
+      <CheckBox v-model="plugin.triggers" :options="PluginsTriggerOptions.slice(0, 3)" />
     </div>
     <div class="form-item">
       <div class="name"></div>
-      <CheckBox v-model="plugin.triggers" :options="PluginsTriggerOptions.slice(6)" />
+      <CheckBox v-model="plugin.triggers" :options="PluginsTriggerOptions.slice(3, 7)" />
+    </div>
+    <div class="form-item">
+      <div class="name"></div>
+      <CheckBox v-model="plugin.triggers" :options="PluginsTriggerOptions.slice(7)" />
     </div>
     <div class="form-item">
       {{ t('plugin.name') }} *