add the ability to import/export settings

Author: cibere

CHANGELOG.txt

@@ -5,4 +5,5 @@ v2.0.0
 - rewrite webserver
 - add doc presets for autohotkey, discord.dev, discord.sex, flowlauncher.com, lua, mdn, and qmk.
 - Add the ability to choose a custom port
-- Add an auto doctype option for the plugin to try and detect if it can index a doc
+- Add an auto doctype option for the plugin to try and detect if it can index a doc
+- Add the ability to import/export settings

plugin/server/core.py

@@ -1,13 +1,15 @@
 from __future__ import annotations
 
 import asyncio
+import base64
 import json
 import logging
 import os
 from typing import TYPE_CHECKING, Callable
 
 import aiohttp_jinja2
 import jinja2
+import msgspec
 from aiohttp import web
 
 from ..libraries import doc_types, preset_docs
@@ -32,6 +34,27 @@
 }
 
 
+class PartialLibrary(msgspec.Struct):
+    name: str
+    type: str
+    loc: str | None
+    use_cache: bool
+
+    def to_dict(self):
+        return {
+            "name": self.name,
+            "type": self.type,
+            "loc": self.loc,
+            "use_cache": self.use_cache,
+        }
+
+
+class ImportExportSettings(msgspec.Struct):
+    port: int
+    keyword: str
+    libraries: list[PartialLibrary]
+
+
 def build_app(
     write_settings: Callable[[list[dict[str, str]]], Awaitable[None]],
     plugin: RtfmPlugin,
@@ -67,6 +90,41 @@ async def set_static_port(request: web.Request):
             return web.json_response({"success": True})
         return web.json_response({"success": False})
 
+    @routes.get("/api/export_settings")
+    async def export_settings(request: web.Request):
+        obj = ImportExportSettings(
+            plugin.static_port,
+            plugin.main_kw,
+            [
+                PartialLibrary(
+                    lib.name,
+                    lib.classname,
+                    None if lib.is_preset else str(lib.loc),
+                    lib.use_cache,
+                )
+                for lib in plugin.libraries.values()
+            ],
+        )
+        return web.json_response(
+            {
+                "success": True,
+                "data": base64.b64encode(msgspec.json.encode(obj)).decode(),
+            }
+        )
+
+    @routes.post("/api/import_settings")
+    async def import_settings(request: web.Request):
+        raw = await request.content.read()
+        try:
+            data = msgspec.json.decode(base64.b64decode(raw), type=ImportExportSettings)
+        except msgspec.DecodeError:
+            return web.json_response({"success": False})
+
+        await write_settings([lib.to_dict() for lib in data.libraries])
+        plugin.main_kw = data.keyword
+        plugin.static_port = data.port
+        return web.json_response({"success": True})
+
     @routes.get("/")
     @aiohttp_jinja2.template("template.html")
     async def index(request: web.Request):

plugin/server/script.js

@@ -325,4 +325,26 @@ async function saveStaticPort() {
 
     console.log("Static Port Saved", resp);
     alert("Static Port Updated. Restart flow for it to take affect.");
+}
+async function importSettings(data) {
+    let resp = await fetch("/api/import_settings", {
+        method: "POST",
+        body: data
+    }).then(response => response.json())
+    if (resp['success'] === true){
+        console.log("Settings Imported", resp);
+        alert("Settings have been imported.");
+    } else {
+        console.log("Data was malformed and settings were not imported successfully.", resp);
+        alert("Data was malformed and settings were not imported successfully. Restart flow launcher for port setting to take affect.");
+    }
+    
+}
+async function exportSettings() {
+    let resp = await fetch("/api/export_settings", {
+        method: "GET"
+    }).then(response => response.json())
+    navigator.clipboard.writeText(resp['data'])
+    console.log("Settings exported", resp);
+    alert("Settings have been successfully expored. You can use the text that has been copied to your clipboard to import them on another device.");
 }

plugin/server/template.html

@@ -35,6 +35,11 @@
           <br>
           <span style="font-size: small;">Setting this to 0 will let your system choose the port each time the plugin starts.</span>
         </div>
+        <hr>
+        <div>
+          <button class="button" onclick="importSettings(prompt('Code from export: '))">Import Settings</button>
+          <button class="button" onclick="exportSettings()">Export Settings</button>
+        </div>
     </body>
     <script src="data.js"></script>
     <script src="script.js"></script>