@galaxy-tool-util/gxwf-report-shell 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 John Chilton
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # @galaxy-tool-util/gxwf-report-shell
2
+
3
+ Pre-built Vue 3 + PrimeVue workflow report components as a self-contained IIFE bundle for CDN delivery.
4
+
5
+ ## Usage — standalone HTML report (Python)
6
+
7
+ ```python
8
+ import json
9
+
10
+ _CDN_VERSION = "0.1.0"
11
+ _CDN_BASE = f"https://cdn.jsdelivr.net/npm/@galaxy-tool-util/gxwf-report-shell@{_CDN_VERSION}/dist"
12
+
13
+ def report_to_html(report_type: str, report_data: dict, *, title: str = "gxwf Report") -> str:
14
+ payload = json.dumps({"type": report_type, "data": report_data})
15
+ return f"""<!DOCTYPE html>
16
+ <html lang="en">
17
+ <head>
18
+ <meta charset="UTF-8">
19
+ <title>{title}</title>
20
+ <link rel="stylesheet" href="{_CDN_BASE}/shell.css">
21
+ </head>
22
+ <body>
23
+ <div id="gxwf-report"></div>
24
+ <script>window.__GXWF_REPORT__ = {payload};</script>
25
+ <script src="{_CDN_BASE}/shell.iife.js"></script>
26
+ </body>
27
+ </html>"""
28
+ ```
29
+
30
+ `report_type` is one of `"validate"`, `"lint"`, `"clean"`, `"roundtrip"`. `report_data` is `report.model_dump(mode="json")` from a `Single{Validation,Lint,Clean,RoundTrip}Report` Pydantic model.
31
+
32
+ ## Usage — VSCode webview
33
+
34
+ Load `dist/shell.iife.js` and `dist/shell.css` from the extension's bundled assets, then send:
35
+
36
+ ```javascript
37
+ panel.webview.postMessage({ command: "render", type: "validate", data: reportData });
38
+ ```
39
+
40
+ ## Usage — gxwf-ui (workspace)
41
+
42
+ ```typescript
43
+ import { ValidationReport, LintReport, CleanReport, RoundtripReport } from "@galaxy-tool-util/gxwf-report-shell";
44
+ ```
45
+
46
+ ## Local smoke test
47
+
48
+ After `pnpm build`, open `smoke-test.html` in a browser to verify all four report types render.
49
+
50
+ ## CDN URLs
51
+
52
+ ```
53
+ https://cdn.jsdelivr.net/npm/@galaxy-tool-util/gxwf-report-shell@{version}/dist/shell.iife.js
54
+ https://cdn.jsdelivr.net/npm/@galaxy-tool-util/gxwf-report-shell@{version}/dist/shell.css
55
+ ```
package/dist/shell.css ADDED
@@ -0,0 +1 @@
1
+ .tool-id[data-v-ea66ff61]{font-family:ui-monospace,Cascadia Code,Source Code Pro,Menlo,Consolas,monospace;font-size:.85em}.operation-report[data-v-90e41dfd]{display:flex;flex-direction:column;gap:.75rem}.summary-row[data-v-90e41dfd]{display:flex;gap:.5rem;flex-wrap:wrap}.key-list[data-v-90e41dfd]{margin:0;padding-left:1.25rem}.skip-reason[data-v-90e41dfd],.no-changes[data-v-90e41dfd]{color:var(--p-text-color-secondary, #6c757d);font-style:italic}.content-pre[data-v-90e41dfd]{margin:0;padding:.5rem;font-size:.75rem;background:var(--p-content-background);border:1px solid var(--p-content-border-color);border-radius:4px;color:var(--p-text-color);overflow:auto;max-height:500px;white-space:pre}.operation-report[data-v-57b69e9d]{display:flex;flex-direction:column;gap:.75rem}.summary-row[data-v-57b69e9d]{display:flex;gap:.5rem;flex-wrap:wrap}.results-table[data-v-57b69e9d]{margin-top:.5rem}.error-list[data-v-57b69e9d]{margin:0;padding-left:1.25rem}.operation-report[data-v-34d4214c]{display:flex;flex-direction:column;gap:.75rem}.summary-row[data-v-34d4214c]{display:flex;gap:.5rem;flex-wrap:wrap}.results-table[data-v-34d4214c]{margin-top:.5rem}.error-list[data-v-34d4214c]{margin:0;padding-left:1.25rem}.operation-report[data-v-e653ad89]{display:flex;flex-direction:column;gap:.75rem}.summary-row[data-v-e653ad89]{display:flex;align-items:center;gap:.75rem}.summary-line[data-v-e653ad89]{font-size:.9rem;color:var(--p-text-color-secondary, #6c757d)}.section-heading[data-v-e653ad89]{margin:.25rem 0 0;font-size:.95rem;display:flex;align-items:center;gap:.4rem}.failure-list[data-v-e653ad89]{margin:0;padding-left:1.25rem;font-size:.85rem}.content-pre[data-v-e653ad89]{margin:0;padding:.5rem;font-size:.75rem;background:var(--p-content-background);border:1px solid var(--p-content-border-color);border-radius:4px;color:var(--p-text-color);overflow:auto;max-height:500px;white-space:pre}.operation-report[data-v-5288a14b]{display:flex;flex-direction:column;gap:.75rem}.summary-row[data-v-5288a14b]{display:flex;gap:.5rem;flex-wrap:wrap}.path-row[data-v-5288a14b]{display:flex;flex-direction:column;gap:.25rem;font-size:.9rem}.path-label[data-v-5288a14b]{color:var(--p-text-color-secondary, #6c757d);margin-right:.25rem}.muted[data-v-5288a14b]{color:var(--p-text-color-secondary, #6c757d);font-style:italic}.content-pre[data-v-5288a14b]{margin:0;padding:.5rem;font-size:.75rem;background:var(--p-content-background);border:1px solid var(--p-content-border-color);border-radius:4px;color:var(--p-text-color);overflow:auto;max-height:500px;white-space:pre}.tree-report[data-v-5d4fdbb2]{display:flex;flex-direction:column;gap:1rem}.root-path[data-v-5d4fdbb2]{font-family:monospace;color:var(--p-text-color-secondary, #6c757d);margin:0}.summary-row[data-v-5d4fdbb2]{display:flex;gap:.5rem;flex-wrap:wrap}.category-heading[data-v-5d4fdbb2]{font-size:1rem;font-weight:600;margin:0;color:var(--p-text-color, #212529)}.category-count[data-v-5d4fdbb2]{font-weight:400;color:var(--p-text-color-secondary, #6c757d)}.category-table[data-v-5d4fdbb2]{margin-top:.25rem}.detail-note[data-v-5d4fdbb2]{font-style:italic;color:var(--p-text-color-secondary, #6c757d)}.tree-report[data-v-ebd1b5f3]{display:flex;flex-direction:column;gap:1rem}.root-path[data-v-ebd1b5f3]{font-family:monospace;color:var(--p-text-color-secondary, #6c757d);margin:0}.summary-row[data-v-ebd1b5f3]{display:flex;gap:.5rem;flex-wrap:wrap}.category-heading[data-v-ebd1b5f3]{font-size:1rem;font-weight:600;margin:0;color:var(--p-text-color, #212529)}.category-count[data-v-ebd1b5f3]{font-weight:400;color:var(--p-text-color-secondary, #6c757d)}.category-table[data-v-ebd1b5f3]{margin-top:.25rem}.detail-note[data-v-ebd1b5f3]{font-style:italic;color:var(--p-text-color-secondary, #6c757d)}.tree-report[data-v-abf2f4e5]{display:flex;flex-direction:column;gap:1rem}.root-path[data-v-abf2f4e5]{font-family:monospace;color:var(--p-text-color-secondary, #6c757d);margin:0}.summary-row[data-v-abf2f4e5]{display:flex;gap:.5rem;flex-wrap:wrap}.category-heading[data-v-abf2f4e5]{font-size:1rem;font-weight:600;margin:0;color:var(--p-text-color, #212529)}.category-count[data-v-abf2f4e5]{font-weight:400;color:var(--p-text-color-secondary, #6c757d)}.category-table[data-v-abf2f4e5]{margin-top:.25rem}.detail-note[data-v-abf2f4e5]{font-style:italic;color:var(--p-text-color-secondary, #6c757d)}.tree-report[data-v-5524ba78]{display:flex;flex-direction:column;gap:1rem}.root-path[data-v-5524ba78]{font-family:monospace;color:var(--p-text-color-secondary, #6c757d);margin:0}.summary-row[data-v-5524ba78]{display:flex;gap:.5rem;flex-wrap:wrap}.category-heading[data-v-5524ba78]{font-size:1rem;font-weight:600;margin:0;color:var(--p-text-color, #212529)}.category-count[data-v-5524ba78]{font-weight:400;color:var(--p-text-color-secondary, #6c757d)}.category-table[data-v-5524ba78]{margin-top:.25rem}.detail-note[data-v-5524ba78]{font-style:italic;color:var(--p-text-color-secondary, #6c757d)}.gxwf-report-shell[data-v-fb7a5c4a]{font-family:system-ui,-apple-system,sans-serif;padding:1.5rem;max-width:1200px;margin:0 auto}.report-header[data-v-fb7a5c4a]{display:flex;align-items:baseline;gap:.75rem;margin-bottom:1.25rem;padding-bottom:.75rem;border-bottom:1px solid var(--p-content-border-color, #dee2e6)}.report-type[data-v-fb7a5c4a]{font-size:1.25rem;font-weight:600;text-transform:capitalize;color:var(--p-text-color, #212529)}.report-path[data-v-fb7a5c4a]{font-family:monospace;font-size:.9rem;color:var(--p-text-color-secondary, #6c757d);overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.unknown-type[data-v-fb7a5c4a]{color:var(--p-text-color-secondary, #6c757d);font-style:italic}