feat: plugins can now register updates

Author: feildmaster

src/base/plugin/updater.js

@@ -0,0 +1,48 @@
+import wrap from 'src/utils/2.pokemon.js';
+import { registerModule } from 'src/utils/plugin.js';
+import { registerPlugin } from 'src/hooks/updates';
+import * as settings from 'src/utils/settings/index.js';
+
+// TODO: translation
+const setting = settings.register({
+  name: 'Disable Auto Updates',
+  key: 'underscript.disable.plugins.update',
+  category: 'Plugins',
+});
+
+wrap(() => {
+  const name = 'updater';
+  function mod(plugin) {
+    if (!plugin.version) return undefined;
+
+    let updater = false;
+    const update = plugin.settings().add({
+      name: 'Disable Auto Updates',
+      key: 'plugin.update',
+      default: () => setting.value(),
+      disabled: () => setting.value(),
+      hidden: () => !updater,
+    });
+    setting.on(() => update.refresh());
+
+    Object.assign(plugin, 'canUpdate', {
+      get: () => updater && !setting.value() && !update.value(),
+    });
+
+    return (data = {}) => {
+      if (!['string', 'object'].includes(typeof data)) throw new Error();
+      if (updater) throw new Error('Already registered');
+      const {
+        downloadURL = typeof data === 'string' ? data : undefined,
+        updateURL,
+      } = data;
+      updater = registerPlugin(plugin, { downloadURL, updateURL });
+      return () => {
+        updater();
+        updater = false;
+      };
+    };
+  }
+
+  registerModule(name, mod, 'events', 'settings');
+});

src/hooks/updates.js

@@ -9,6 +9,7 @@ import wrap from 'src/utils/2.pokemon';
 import Translation from 'src/structures/constants/translation';
 import { buttonCSS } from 'src/utils/1.variables';
 import sleep from 'src/utils/sleep';
+import createParser from 'src/utils/parser';
 
 const HOUR = 60 * 60 * 1000;
 const DAY = 24 * HOUR;
@@ -59,6 +60,34 @@ export function register({
   pendingUpdates.set(key, data);
 }
 
+// TODO: keep registry of update URL's being used? only allow one of any url
+export function registerPlugin(plugin, data = {}) {
+  validate(plugin);
+  /** @type {FileParser} */
+  const parser = createParser(data);
+  const { version } = plugin;
+  let finished = false;
+  plugin.events.until(':update', async () => {
+    if (finished || !plugin.canUpdate) return finished;
+    const info = await parser.getUpdateData();
+    const newVersion = await parser.getVersion(info);
+    if (finished || !plugin.canUpdate) return finished;
+    if (newVersion !== version) {
+      register({
+        plugin,
+        version: newVersion,
+        url: await parser.getDownload(info),
+      });
+    } else {
+      unregister(plugin);
+    }
+    return false;
+  });
+  return () => {
+    finished = true;
+  };
+}
+
 export function validate(plugin) {
   const key = plugin.name || plugin;
   const existing = pendingUpdates.get(key);