galaxy-charts 0.0.19 → 0.0.21

package/src/utilities/parseXML.ts

@@ -0,0 +1,156 @@
+import axios from "axios";
+import { getFileName } from "@/utilities/getFileName";
+import type { PluginType } from "@/types";
+const parser = new DOMParser();
+
+interface MacroEntries {
+    [key: string]: Element[];
+}
+
+// Parses the base XML with macros and expands nodes
+async function parseMacros(xmlBaseString: string, xmlPath: string = ""): Promise<Document> {
+    const xmlDoc = parser.parseFromString(xmlBaseString, "text/xml");
+
+    // Parse macros from base XML
+    const macroFiles: string[] = [];
+    const macrosNodes = xmlDoc.documentElement.getElementsByTagName("macros");
+    if (macrosNodes.length > 0) {
+        for (const macroNode of Array.from(macrosNodes)) {
+            for (const element of Array.from(macroNode.children)) {
+                macroFiles.push(element.textContent?.trim() || "");
+            }
+        }
+    }
+    console.debug(`Detected ${macroFiles.length} macro file(s) in xml.`);
+
+    // Load and collect macro entries
+    const xmlEntries: MacroEntries = {};
+    for (const macroFile of macroFiles) {
+        const { data } = await axios.get(`${xmlPath}${macroFile}`);
+        const xmlMacro = parser.parseFromString(data, "text/xml");
+        const xmlNode = xmlMacro.documentElement.getElementsByTagName("xml");
+        if (xmlNode.length > 0) {
+            for (const xmlEntry of Array.from(xmlNode)) {
+                const xmlName = xmlEntry.getAttribute("name");
+                if (xmlName) {
+                    for (const entry of Array.from(xmlEntry.children)) {
+                        xmlEntries[xmlName] = xmlEntries[xmlName] || [];
+                        xmlEntries[xmlName].push(entry);
+                    }
+                }
+            }
+        }
+    }
+    console.debug(`Successfully collected macro files.`);
+
+    // Parse macros from base XML
+    const expandNodes = xmlDoc.documentElement.getElementsByTagName("expand");
+    if (expandNodes.length > 0) {
+        for (const expandNode of Array.from(expandNodes)) {
+            const expandName = expandNode.getAttribute("macro");
+            if (expandName && expandName in xmlEntries) {
+                const entries = xmlEntries[expandName];
+                for (const entry of entries) {
+                    expandNode.parentNode?.appendChild(entry.cloneNode(true));
+                }
+                expandNode.parentNode?.removeChild(expandNode);
+            } else {
+                console.error(`Failed to detect '${expandName}' macros source.`);
+            }
+        }
+    }
+
+    // Returns full XML document with populated macros
+    return xmlDoc;
+}
+
+// Parse XML file and collect attributes
+export async function parseXML(xmlFileName: string): Promise<PluginType> {
+    const xmlBase = await axios.get(xmlFileName);
+    const xmlDoc = await parseMacros(xmlBase.data);
+
+    // Parse name and logo
+    const result: PluginType = { name: getFileName(xmlFileName) };
+    result.html = xmlDoc.documentElement.getAttribute("name");
+    result.logo = xmlDoc.documentElement.getAttribute("logo");
+
+    // Parse description
+    const descriptionNode = xmlDoc.documentElement.getElementsByTagName("description");
+    if (descriptionNode.length === 1) {
+        result.description = descriptionNode[0].textContent?.trim() || null;
+    }
+
+    // Parse specifications
+    const specsNode = xmlDoc.documentElement.getElementsByTagName("specs");
+    if (specsNode.length === 1) {
+        result.specs = new DictParser(specsNode[0]);
+    }
+
+    // Parse inputs from groups and settings sections
+    ["settings", "tracks"].forEach((key) => {
+        const xmlNode = xmlDoc.documentElement.getElementsByTagName(key);
+        if (xmlNode.length === 1) {
+            (result as any)[key] = new ListParser(xmlNode[0]);
+        }
+    });
+
+    return result;
+}
+
+/**
+ * Converts an XML structure into an array
+ */
+class ListParser extends Array {
+    constructor(elements: Element) {
+        super();
+        for (const element of Array.from(elements.children)) {
+            if (element.children.length > 0) {
+                if (element.tagName === element.children[0].tagName) {
+                    this.push(new ListParser(element));
+                } else {
+                    this.push(new DictParser(element));
+                }
+            } else if (element.textContent && element.textContent.trim()) {
+                this.push(element.textContent.trim());
+            }
+        }
+    }
+}
+
+/**
+ * Converts an XML structure into a dictionary
+ */
+class DictParser {
+    [key: string]: any;
+
+    constructor(parentElement: Element) {
+        if (parentElement.attributes.length > 0) {
+            for (const attr of Array.from(parentElement.attributes)) {
+                this[attr.name] = attr.value;
+            }
+        }
+        for (const element of Array.from(parentElement.children)) {
+            if (element.children.length > 0) {
+                let asJson;
+                if (element.tagName === element.children[0].tagName) {
+                    asJson = new ListParser(element);
+                } else {
+                    const aDict = new DictParser(element);
+                    for (const attr of Array.from(element.attributes)) {
+                        aDict[attr.name] = attr.value;
+                    }
+                    asJson = aDict;
+                }
+                this[element.tagName] = asJson;
+            } else if (element.attributes.length > 0) {
+                const attrObj: { [key: string]: string } = {};
+                for (const attr of Array.from(element.attributes)) {
+                    attrObj[attr.name] = attr.value;
+                }
+                this[element.tagName] = attrObj;
+            } else {
+                this[element.tagName] = element.textContent?.trim() || null;
+            }
+        }
+    }
+}

package/src/utilities/simpleError.ts

@@ -0,0 +1,21 @@
+export function errorMessageAsString(e: any, defaultMessage = "Request failed.") {
+    // Note that despite the name, this can actually currently return an object,
+    // depending on what data.err_msg is (e.g. an object)
+    let message = defaultMessage;
+    if (e && e.response && e.response.data && e.response.data.err_msg) {
+        message = e.response.data.err_msg;
+    } else if (e && e.data && e.data.err_msg) {
+        message = e.data.err_msg;
+    } else if (e && e.response) {
+        message = `${e.response.statusText} (${e.response.status})`;
+    } else if (e instanceof Error) {
+        message = e.message;
+    } else if (typeof e == "string") {
+        message = e;
+    }
+    return message;
+}
+
+export function rethrowSimple(e: any): never {
+    throw Error(errorMessageAsString(e));
+}

package/src/utilities/toBoolean.test.js

@@ -0,0 +1,12 @@
+import { toBoolean } from "./toBoolean.ts";
+
+test("to boolean conversion", () => {
+    expect(toBoolean(true)).toBeTruthy();
+    expect(toBoolean("true")).toBeTruthy();
+    expect(toBoolean("TrUe")).toBeTruthy();
+    expect(toBoolean(false)).toBeFalsy();
+    expect(toBoolean("rue")).toBeFalsy();
+    expect(toBoolean(1)).toBeFalsy();
+    expect(toBoolean(null)).toBeFalsy();
+    expect(toBoolean(undefined)).toBeFalsy();
+});

package/src/utilities/toBoolean.ts

@@ -0,0 +1,5 @@
+import type { InputAtomicType } from "@/types";
+
+export function toBoolean(value: InputAtomicType) {
+    return String(value).toLowerCase() === "true";
+}

package/tailwind.config.js

@@ -0,0 +1,8 @@
+/** @type {import('tailwindcss').Config} */
+export default {
+    content: ["./src/**/*.vue"],
+    theme: {
+        extend: {},
+    },
+    plugins: [],
+};

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+    "compilerOptions": {
+       "target": "ESNext",
+       "useDefineForClassFields": true,
+       "module": "ESNext",
+       "moduleResolution": "Node",
+       "strict": true,
+       "jsx": "preserve",
+       "sourceMap": false,
+       "resolveJsonModule": true,
+       "esModuleInterop": true,
+       "lib": ["ESNext", "DOM"],
+       "skipLibCheck": true,
+       "baseUrl": ".",
+       "paths": {
+          "@/*": ["src/*"]
+       }
+    },
+    "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
+    "exclude": [
+        "dist",
+        "docs",
+        "node_modules",
+        "static",
+        "src/App.vue",
+        "src/Plugin.vue"
+    ],
+}

package/vite.config.js

@@ -0,0 +1,70 @@
+import { defineConfig } from "vite";
+import tailwindcss from "tailwindcss";
+import vue from "@vitejs/plugin-vue";
+import path from "path";
+import { libInjectCss } from "vite-plugin-lib-inject-css";
+import { configDefaults } from "vitest/config";
+import Checker from "vite-plugin-checker";
+
+// collect Galaxy server root
+let GALAXY_ROOT = "http://127.0.0.1:8080";
+if (process.env.GALAXY_ROOT) {
+    GALAXY_ROOT = process.env.GALAXY_ROOT;
+} else {
+    console.log("GALAXY_ROOT not available. Please provide as environment variable.");
+}
+
+// collect Galaxy API key
+let GALAXY_KEY = "";
+if (process.env.GALAXY_KEY) {
+    GALAXY_KEY = process.env.GALAXY_KEY;
+} else {
+    console.log("GALAXY_KEY not available. Please provide as environment variable.");
+}
+
+// https://vitejs.dev/config/
+export default defineConfig({
+    build: {
+        lib: {
+            entry: path.resolve(__dirname, "lib/galaxy-charts.js"),
+            name: "GalaxyCharts",
+            fileName: "galaxy-charts",
+        },
+        rollupOptions: {
+            external: ["vue"],
+            output: {
+                globals: { vue: "vue" },
+            },
+        },
+    },
+    define: {
+        "process.env.credentials": JSON.stringify(GALAXY_KEY ? "omit" : "include"),
+    },
+    plugins: [vue(), tailwindcss(), libInjectCss(), Checker({ typescript: true })],
+    resolve: {
+        alias: {
+            "@": path.resolve(__dirname, "src"),
+        },
+    },
+    server: {
+        proxy: {
+            "/api": {
+                changeOrigin: true,
+                rewrite: (path) => {
+                    if (GALAXY_KEY) {
+                        const separator = path.includes("?") ? "&" : "?";
+                        return `${path}${separator}key=${GALAXY_KEY}`;
+                    } else {
+                        return path;
+                    }
+                },
+                target: GALAXY_ROOT,
+            },
+        },
+    },
+    test: {
+        globals: true,
+        environment: "jsdom",
+        exclude: configDefaults.exclude,
+    },
+});

package/dist/galaxy-charts.css

@@ -1 +0,0 @@
-*,:before,:after{box-sizing:border-box;border-width:0;border-style:solid;border-color:#e5e7eb}:before,:after{--tw-content: ""}html,:host{line-height:1.5;-webkit-text-size-adjust:100%;-moz-tab-size:4;-o-tab-size:4;tab-size:4;font-family:ui-sans-serif,system-ui,sans-serif,"Apple Color Emoji","Segoe UI Emoji",Segoe UI Symbol,"Noto Color Emoji";font-feature-settings:normal;font-variation-settings:normal;-webkit-tap-highlight-color:transparent}body{margin:0;line-height:inherit}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}a{color:inherit;text-decoration:inherit}b,strong{font-weight:bolder}code,kbd,samp,pre{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-feature-settings:normal;font-variation-settings:normal;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}button,input,optgroup,select,textarea{font-family:inherit;font-feature-settings:inherit;font-variation-settings:inherit;font-size:100%;font-weight:inherit;line-height:inherit;letter-spacing:inherit;color:inherit;margin:0;padding:0}button,select{text-transform:none}button,input:where([type=button]),input:where([type=reset]),input:where([type=submit]){-webkit-appearance:button;background-color:transparent;background-image:none}:-moz-focusring{outline:auto}:-moz-ui-invalid{box-shadow:none}progress{vertical-align:baseline}::-webkit-inner-spin-button,::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}summary{display:list-item}blockquote,dl,dd,h1,h2,h3,h4,h5,h6,hr,figure,p,pre{margin:0}fieldset{margin:0;padding:0}legend{padding:0}ol,ul,menu{list-style:none;margin:0;padding:0}dialog{padding:0}textarea{resize:vertical}input::-moz-placeholder,textarea::-moz-placeholder{opacity:1;color:#9ca3af}input::placeholder,textarea::placeholder{opacity:1;color:#9ca3af}button,[role=button]{cursor:pointer}:disabled{cursor:default}img,svg,video,canvas,audio,iframe,embed,object{display:block;vertical-align:middle}img,video{max-width:100%;height:auto}[hidden]{display:none}*,:before,:after{--tw-border-spacing-x: 0;--tw-border-spacing-y: 0;--tw-translate-x: 0;--tw-translate-y: 0;--tw-rotate: 0;--tw-skew-x: 0;--tw-skew-y: 0;--tw-scale-x: 1;--tw-scale-y: 1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness: proximity;--tw-gradient-from-position: ;--tw-gradient-via-position: ;--tw-gradient-to-position: ;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width: 0px;--tw-ring-offset-color: #fff;--tw-ring-color: rgb(59 130 246 / .5);--tw-ring-offset-shadow: 0 0 #0000;--tw-ring-shadow: 0 0 #0000;--tw-shadow: 0 0 #0000;--tw-shadow-colored: 0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: ;--tw-contain-size: ;--tw-contain-layout: ;--tw-contain-paint: ;--tw-contain-style: }::backdrop{--tw-border-spacing-x: 0;--tw-border-spacing-y: 0;--tw-translate-x: 0;--tw-translate-y: 0;--tw-rotate: 0;--tw-skew-x: 0;--tw-skew-y: 0;--tw-scale-x: 1;--tw-scale-y: 1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness: proximity;--tw-gradient-from-position: ;--tw-gradient-via-position: ;--tw-gradient-to-position: ;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width: 0px;--tw-ring-offset-color: #fff;--tw-ring-color: rgb(59 130 246 / .5);--tw-ring-offset-shadow: 0 0 #0000;--tw-ring-shadow: 0 0 #0000;--tw-shadow: 0 0 #0000;--tw-shadow-colored: 0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: ;--tw-contain-size: ;--tw-contain-layout: ;--tw-contain-paint: ;--tw-contain-style: }.z-10{z-index:10}.m-1{margin:.25rem}.m-2{margin:.5rem}.m-4{margin:1rem}.mx-1{margin-left:.25rem;margin-right:.25rem}.my-1{margin-top:.25rem;margin-bottom:.25rem}.my-2{margin-top:.5rem;margin-bottom:.5rem}.mb-1{margin-bottom:.25rem}.mb-2{margin-bottom:.5rem}.mr-1{margin-right:.25rem}.mt-0{margin-top:0}.mt-2{margin-top:.5rem}.block{display:block}.inline{display:inline}.flex{display:flex}.grid{display:grid}.\!hidden{display:none!important}.hidden{display:none}.size-14{width:3.5rem;height:3.5rem}.size-3{width:.75rem;height:.75rem}.size-4{width:1rem;height:1rem}.h-screen{height:100vh}.w-full{width:100%}.min-w-14{min-width:3.5rem}.max-w-14{max-width:3.5rem}.flex-1{flex:1 1 0%}@keyframes spin{to{transform:rotate(360deg)}}.animate-spin{animation:spin 1s linear infinite}.select-none{-webkit-user-select:none;-moz-user-select:none;user-select:none}.resize{resize:both}.grid-cols-\[70\%_30\%\]{grid-template-columns:70% 30%}.justify-center{justify-content:center}.overflow-auto{overflow:auto}.overflow-hidden{overflow:hidden}.break-words{overflow-wrap:break-word}.rounded{border-radius:.25rem}.rounded-lg{border-radius:.5rem}.border{border-width:1px}.border-dotted{border-style:dotted}.border-green-600{--tw-border-opacity: 1;border-color:rgb(22 163 74 / var(--tw-border-opacity))}.bg-gray-600{--tw-bg-opacity: 1;background-color:rgb(75 85 99 / var(--tw-bg-opacity))}.bg-sky-100{--tw-bg-opacity: 1;background-color:rgb(224 242 254 / var(--tw-bg-opacity))}.bg-sky-50{--tw-bg-opacity: 1;background-color:rgb(240 249 255 / var(--tw-bg-opacity))}.bg-white{--tw-bg-opacity: 1;background-color:rgb(255 255 255 / var(--tw-bg-opacity))}.object-contain{-o-object-fit:contain;object-fit:contain}.p-1{padding:.25rem}.p-2{padding:.5rem}.p-4{padding:1rem}.px-4{padding-left:1rem;padding-right:1rem}.py-1{padding-top:.25rem;padding-bottom:.25rem}.pb-1{padding-bottom:.25rem}.pb-2{padding-bottom:.5rem}.text-lg{font-size:1.125rem;line-height:1.75rem}.text-xs{font-size:.75rem;line-height:1rem}.font-bold{font-weight:700}.font-thin{font-weight:100}.text-green-600{--tw-text-opacity: 1;color:rgb(22 163 74 / var(--tw-text-opacity))}.text-red-600{--tw-text-opacity: 1;color:rgb(220 38 38 / var(--tw-text-opacity))}.text-sky-900{--tw-text-opacity: 1;color:rgb(12 74 110 / var(--tw-text-opacity))}.text-white{--tw-text-opacity: 1;color:rgb(255 255 255 / var(--tw-text-opacity))}.filter{filter:var(--tw-blur) var(--tw-brightness) var(--tw-contrast) var(--tw-grayscale) var(--tw-hue-rotate) var(--tw-invert) var(--tw-saturate) var(--tw-sepia) var(--tw-drop-shadow)}@media (min-width: 768px){.md\:flex{display:flex}}