[Feat] Early support for PLS & Use JSDoc (Partially)

src/aura/ui/composables/plsConfigManager.js

@@ -0,0 +1,93 @@
+// @ts-check
+
+const __SCOPE = "assistant / rendererCommon";
+
+const IPC_METHOD_BASE = "$aura.pls";
+
+const updatePlsStatusFromLocal = async () => {
+  const plsStatus = (
+    await global.ipcRenderer.invoke(`${IPC_METHOD_BASE}.getPlsStats`)
+  ).data;
+  global.__HUGO_AURA_GLOBAL__.plsStatus = plsStatus;
+  return plsStatus;
+};
+
+const updatePlsSettingsFromLocal = async () => {
+  const plsSettings = (
+    await global.ipcRenderer.invoke(`${IPC_METHOD_BASE}.getPlsSettings`)
+  ).data;
+  global.__HUGO_AURA_GLOBAL__.plsSettings = plsSettings;
+  return plsSettings;
+};
+
+const updatePlsRulesFromLocal = async () => {
+  const plsRules = (
+    await global.ipcRenderer.invoke(`${IPC_METHOD_BASE}.getPlsRules`)
+  ).data;
+  global.__HUGO_AURA_GLOBAL__.plsRules = plsRules;
+  return plsRules;
+};
+
+/**
+ *
+ * @returns {string}
+ */
+const genRandomHex = () => {
+  let result = "";
+  for (let i = 0; i < 8; i++) {
+    const randomNum = Math.floor(Math.random() * 0x10000);
+    result += randomNum.toString(16).padStart(4, "0");
+  }
+  return result;
+};
+
+/**
+ *
+ * @param {string} configKey
+ * @param {any} configValue
+ */
+const updatePlsConfigToRemote = async (configKey, configValue) => {
+  const configLevels = configKey.split(".");
+  /** @type {Record<any, any>} */
+  let localUpdateTarget =
+    configLevels[0] === "ruleSettings"
+      ? global.__HUGO_AURA_GLOBAL__.plsRules
+      : global.__HUGO_AURA_GLOBAL__.plsSettings;
+  for (const level of configLevels.slice(0, -1)) {
+    localUpdateTarget = localUpdateTarget[level];
+  }
+  localUpdateTarget[configLevels.slice(-1)[0]] = configValue;
+
+  const plsConfigUpdateEvent = new CustomEvent("onPLSConfigUpdate", {
+    detail: {
+      path: configKey,
+      value: configValue,
+    },
+  });
+  document.dispatchEvent(plsConfigUpdateEvent);
+
+  /**
+   * @type {ClientPLSRequest}
+   */
+  const data = {
+    method: "config.action.updateConfig",
+    data: {
+      key: configKey,
+      value: configValue,
+    },
+    eventId: genRandomHex(), // 不用 crypto, 因为会带来不必要的性能开销
+  };
+
+  global.ipcRenderer.invoke(`${IPC_METHOD_BASE}.ws.sendWsMessage`, data);
+  global.ipcRenderer.invoke(`${IPC_METHOD_BASE}.syncPlsConfig`, {
+    basic: global.__HUGO_AURA_GLOBAL__.plsSettings,
+    rules: global.__HUGO_AURA_GLOBAL__.plsRules,
+  });
+};
+
+module.exports = {
+  updatePlsRulesFromLocal,
+  updatePlsStatusFromLocal,
+  updatePlsSettingsFromLocal,
+  updatePlsConfigToRemote,
+};

src/aura/ui/composables/settingsRenderer.js

@@ -18,15 +18,30 @@ const showRelaunchToast = () => {
   if (!toastBs.isShown()) toastBs.show();
 };
 
+const showRelaunchPLSToast = () => {
+  const toast = document.getElementById("relaunchPlsNotifyToast");
+  const toastBs = bootstrap.Toast.getOrCreateInstance(toast);
+
+  if (global.__HUGO_AURA_GLOBAL__.plsStatus.detached) {
+    const relaunchBtn = document.getElementById("plsRelaunchBtn");
+    relaunchBtn.disabled = true;
+    relaunchBtn.textContent = "分离模式下无法执行"
+  }
+
+  if (!toastBs.isShown()) toastBs.show();
+};
+
 const showToast = (entry) => {
   if (entry.reload) {
     showReloadToast();
   } else if (entry.restart) {
     showRelaunchToast();
+  } else if (entry.restartPLS) {
+    showRelaunchPLSToast();
   }
 };
 
-const settingsRenderer = (pendingEl, settingsObj) => {
+const settingsRenderer = (pendingEl, settingsObj, isPls = false) => {
   const formEl = document.createElement("form");
   formEl.classList.add("aura-settings-form");
   for (const category of settingsObj) {
@@ -56,6 +71,18 @@ const settingsRenderer = (pendingEl, settingsObj) => {
         powerIcon.setAttribute("data-bs-title", "需要重启 Electron 进程");
         entryTitle.appendChild(powerIcon);
       }
+      if (entry.restartPLS) {
+        const plsIcon = document.createElement("i");
+        plsIcon.classList.add(
+          "layui-icon",
+          "layui-icon-logout",
+          "aura-settings-entry-property-icon"
+        );
+        plsIcon.setAttribute("data-bs-toggle", "tooltip");
+        plsIcon.setAttribute("data-bs-placement", "top");
+        plsIcon.setAttribute("data-bs-title", "需要重启 PLS 进程");
+        entryTitle.appendChild(plsIcon);
+      }
       if (entry.reload) {
         const reloadIcon = document.createElement("i");
         reloadIcon.classList.add(
@@ -182,14 +209,18 @@ const settingsRenderer = (pendingEl, settingsObj) => {
       if (!isShow) entryContainerEl.classList.add("aura-settings-entry-hidden");
 
       if (entry.associateVal) {
-        document.addEventListener("onHugoAuraConfigUpdate", (event) => {
-          if (!entry.associateVal.includes(event.detail.path.join("."))) return;
-          const cls = entryContainerEl.classList;
-          const isShow = entry.auraIf();
-          isShow
-            ? cls.remove("aura-settings-entry-hidden")
-            : cls.add("aura-settings-entry-hidden");
-        });
+        document.addEventListener(
+          isPls ? "onPLSConfigUpdate" : "onHugoAuraConfigUpdate",
+          (event) => {
+            if (!entry.associateVal.includes(event.detail.path.join(".")))
+              return;
+            const cls = entryContainerEl.classList;
+            const isShow = entry.auraIf();
+            isShow
+              ? cls.remove("aura-settings-entry-hidden")
+              : cls.add("aura-settings-entry-hidden");
+          }
+        );
       }
 
       formEl.appendChild(entryContainerEl);