@matdata/yasgui-utils 5.20.3 → 6.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.
Files changed (2) hide show
  1. package/README.md +76 -59
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,9 +1,19 @@
1
- # YASGUI
1
+ # MatGUI
2
2
 
3
- **Yet Another SPARQL GUI (YASGUI)** is a powerful, user-friendly web-based interface for querying and exploring RDF data using SPARQL. It combines a feature-rich query editor (YASQE) with a versatile results viewer (YASR) to provide a comprehensive SPARQL IDE.
3
+ ### A modern knowledge graph and SPARQL workbench
4
4
 
5
- 🌐 **Try it now**: [https://yasgui.matdata.eu/](https://yasgui.matdata.eu/)
5
+ > **More than just Another SPARQL GUI.**
6
6
 
7
+ **MatGUI** is a powerful, user-friendly web-based workbench for querying, exploring and visualising knowledge graphs and RDF data with SPARQL. It combines a feature-rich query editor with a versatile results viewer to provide a complete SPARQL IDE.
8
+
9
+ > **Formerly Yasgui.** MatGUI began as a fork of the Yasgui ecosystem and has since evolved well beyond it. The npm packages (`@matdata/yasgui`, `@matdata/yasqe`, `@matdata/yasr`) keep their names for backwards compatibility — **only the project branding has changed.** See the [Rebranding & migration Guide](./docs/rebranding-to-matgui.md).
10
+
11
+ 🌐 **Try it now**: [https://matgui.matdata.eu/](https://matgui.matdata.eu/)
12
+
13
+ [![GitHub release](https://img.shields.io/github/v/release/Matdata-eu/Matgui?label=stable%20release)](https://github.com/Matdata-eu/Matgui/releases)
14
+ [![Docker Image Version](https://img.shields.io/docker/v/mathiasvda/matgui?sort=semver)](https://hub.docker.com/r/mathiasvda/matgui)
15
+ [![CI](https://github.com/Matdata-eu/Matgui/actions/workflows/build.yml/badge.svg)](https://github.com/Matdata-eu/Matgui/actions/workflows/build.yml)
16
+ [![Try it live](https://img.shields.io/badge/Live-matgui.matdata.eu-2ea44f?logo=globe&logoColor=white)](https://matgui.matdata.eu/)
7
17
  [![npm version](https://img.shields.io/npm/v/@matdata/yasgui)](https://www.npmjs.com/package/@matdata/yasgui)
8
18
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
9
19
 
@@ -11,26 +21,26 @@
11
21
 
12
22
  ## Quick Links
13
23
 
14
- - 📖 **[User Guide](./docs/user-guide.md)** - Complete guide for end users
15
- - 🛠️ **[Developer Guide](./docs/developer-guide.md)** - API reference and integration guide
16
- - 🚀 **[Production Environment](https://yasgui.matdata.eu/)** - Live instance
24
+ - 📖 **[User Guide](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md)** - Complete guide for end users
25
+ - 🛠️ **[Developer Guide](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md)** - API reference and integration guide
26
+ - 🚀 **[Production Environment](https://matgui.matdata.eu/)** - Live instance
17
27
  - 📦 **[npm Package](https://www.npmjs.com/package/@matdata/yasgui)**
18
- - 🐳 **[Docker Hub](https://hub.docker.com/r/mathiasvda/yasgui)**
19
- - 📝 **[Releases & Changelog](https://github.com/Matdata-eu/Yasgui/releases)**
20
- - 💻 **[GitHub Repository](https://github.com/Matdata-eu/Yasgui)**
28
+ - 🐳 **[Docker Hub](https://hub.docker.com/r/mathiasvda/matgui)**
29
+ - 📝 **[Releases & Changelog](https://github.com/Matdata-eu/Matgui/releases)**
30
+ - 💻 **[GitHub Repository](https://github.com/Matdata-eu/MatGUI)**
21
31
 
22
32
  ---
23
33
 
24
34
  ## Documentation
25
35
 
26
- The **documentation for YASGUI is hosted on GitHub Pages**:
36
+ The **documentation for Matgui is hosted on GitHub Pages**:
27
37
 
28
- - **📚 Documentation Website**: [https://yasgui-doc.matdata.eu/](https://matdata-eu.github.io/Yasgui/)
38
+ - **📚 Documentation Website**: [https://matgui-doc.matdata.eu/](https://matdata-eu.github.io/Yasgui/)
29
39
  - User Guide, Developer Guide, API Reference
30
40
  - Built with Docusaurus
31
41
  - Version-tagged with the repository
32
42
 
33
- - **🚀 Development Build**: [https://yasgui-doc.matdata.eu/dev/main/](https://matdata-eu.github.io/Yasgui/dev/main/)
43
+ - **🚀 Development Build**: [https://matgui-doc.matdata.eu/dev/main/](https://matdata-eu.github.io/Yasgui/dev/main/)
34
44
  - Live build from the main branch
35
45
  - Updated automatically with every commit
36
46
  - Test latest features before release
@@ -39,45 +49,45 @@ The documentation is version-tagged with the repository, ensuring consistency be
39
49
 
40
50
  ## Features
41
51
 
42
- YASGUI provides a complete SPARQL development environment with powerful features:
52
+ Matgui provides a complete SPARQL development environment with powerful features:
43
53
 
44
54
  ### ✏️ Advanced Query Editor
45
- - **[SPARQL Syntax Highlighting](./docs/user-guide.md#yasqe-query-editor)** - Color-coded SPARQL with error detection
46
- - **[Smart Autocomplete](./docs/user-guide.md#prefix-management)** - Context-aware suggestions for keywords, prefixes, and URIs
47
- - **[Query Formatting](./docs/user-guide.md#query-formatting)** - One-click query beautification with configurable formatters
48
- - **[Prefix Management](./docs/user-guide.md#prefix-management)** - Auto-capture and reuse PREFIX declarations
49
- - **[URI Explorer](./docs/user-guide.md#uri-explorer)** - Ctrl+Click URIs to explore connections
50
- - **[Keyboard Shortcuts](./docs/user-guide.md#keyboard-shortcuts)** - Efficient query development workflow
55
+ - **[SPARQL Syntax Highlighting](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#yasqe-query-editor)** - Color-coded SPARQL with error detection
56
+ - **[Smart Autocomplete](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#prefix-management)** - Context-aware suggestions for keywords, prefixes, and URIs
57
+ - **[Query Formatting](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#query-formatting)** - One-click query beautification with configurable formatters
58
+ - **[Prefix Management](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#prefix-management)** - Auto-capture and reuse PREFIX declarations
59
+ - **[URI Explorer](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#uri-explorer)** - Ctrl+Click URIs to explore connections
60
+ - **[Keyboard Shortcuts](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#keyboard-shortcuts)** - Efficient query development workflow
51
61
 
52
62
  ### 📊 Powerful Visualizations
53
- - **[Table Plugin](./docs/user-guide.md#table-plugin)** - Sortable, filterable, paginated result tables
54
- - **[Graph Plugin](./docs/user-guide.md#graph-plugin)** - Interactive RDF graph visualization
55
- - **[Geo Plugin](./docs/user-guide.md#geo-plugin)** - Geographic data on interactive maps
56
- - **[Response Plugin](./docs/user-guide.md#response-plugin)** - Raw response viewer with syntax highlighting
57
- - **[Boolean Plugin](./docs/user-guide.md#boolean-plugin)** - Visual true/false indicators for ASK queries
58
- - **[Error Plugin](./docs/user-guide.md#error-plugin)** - Detailed error diagnostics
63
+ - **[Table Plugin](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#table-plugin)** - Sortable, filterable, paginated result tables
64
+ - **[Graph Plugin](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#graph-plugin)** - Interactive RDF graph visualization
65
+ - **[Geo Plugin](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#geo-plugin)** - Geographic data on interactive maps
66
+ - **[Response Plugin](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#response-plugin)** - Raw response viewer with syntax highlighting
67
+ - **[Boolean Plugin](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#boolean-plugin)** - Visual true/false indicators for ASK queries
68
+ - **[Error Plugin](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#error-plugin)** - Detailed error diagnostics
59
69
 
60
70
  ### 🎨 Themes & Layouts
61
- - **[Light & Dark Themes](./docs/user-guide.md#themes)** - Seamless theme switching with persistent preferences
62
- - **[Flexible Layouts](./docs/user-guide.md#layout-orientation)** - Vertical or horizontal editor/results arrangement
71
+ - **[Light & Dark Themes](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#themes)** - Seamless theme switching with persistent preferences
72
+ - **[Flexible Layouts](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#layout-orientation)** - Vertical or horizontal editor/results arrangement
63
73
 
64
74
  ### 🔧 Expert Features
65
- - **[Multiple Tabs](./docs/user-guide.md#query-tabs)** - Work on multiple queries simultaneously
66
- - **[Endpoint Management](./docs/user-guide.md#endpoint-quick-switch)** - Quick-switch between SPARQL endpoints
67
- - **[Authentication Support](./docs/developer-guide.md#authentication)** - Basic Auth, Bearer Token, API Key, OAuth2
68
- - **[Persistent Storage](./docs/user-guide.md#query-history-and-persistence)** - Auto-save queries and preferences
69
- - **[URL Sharing](./docs/user-guide.md#share-queries)** - Share queries via URL parameters
70
- - **[Fullscreen Mode](./docs/user-guide.md#fullscreen-mode)** - Maximize editor or results viewer
71
- - **[Export Results](./docs/developer-guide.md#yasr-class)** - Download results in various formats
72
- - **[Configuration Import/Export](./docs/user-guide.md#configuration-importexport)** - Backup and restore settings
75
+ - **[Multiple Tabs](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#query-tabs)** - Work on multiple queries simultaneously
76
+ - **[Endpoint Management](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#endpoint-quick-switch)** - Quick-switch between SPARQL endpoints
77
+ - **[Authentication Support](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md#authentication)** - Basic Auth, Bearer Token, API Key, OAuth2
78
+ - **[Persistent Storage](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#query-history-and-persistence)** - Auto-save queries and preferences
79
+ - **[URL Sharing](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#share-queries)** - Share queries via URL parameters
80
+ - **[Fullscreen Mode](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#fullscreen-mode)** - Maximize editor or results viewer
81
+ - **[Export Results](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md#yasr-class)** - Download results in various formats
82
+ - **[Configuration Import/Export](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#configuration-importexport)** - Backup and restore settings
73
83
 
74
- For detailed feature documentation, see the **[User Guide](./docs/user-guide.md)**.
84
+ For detailed feature documentation, see the **[User Guide](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md)**.
75
85
 
76
86
  ---
77
87
 
78
88
  ## Browser Support
79
89
 
80
- YASGUI works on all modern browsers:
90
+ Matgui works on all modern browsers:
81
91
 
82
92
  - ✅ Chrome / Edge (latest)
83
93
  - ✅ Firefox (latest)
@@ -116,8 +126,8 @@ yarn add @matdata/yasgui
116
126
 
117
127
  **Run with default endpoint:**
118
128
  ```bash
119
- docker pull mathiasvda/yasgui:latest
120
- docker run -p 8080:8080 mathiasvda/yasgui:latest
129
+ docker pull mathiasvda/matgui:latest
130
+ docker run -p 8080:8080 mathiasvda/matgui:latest
121
131
  ```
122
132
 
123
133
  Access at: `http://localhost:8080`
@@ -125,11 +135,12 @@ Access at: `http://localhost:8080`
125
135
  **Custom endpoint:**
126
136
  ```bash
127
137
  docker run -p 8080:8080 \
128
- -e YASGUI_DEFAULT_ENDPOINT=https://your-endpoint.com/sparql \
129
- mathiasvda/yasgui:latest
138
+ -e MATGUI_DEFAULT_ENDPOINT=https://your-endpoint.com/sparql \
139
+ mathiasvda/matgui:latest
130
140
  ```
131
141
 
132
- For detailed installation instructions and usage examples, see the **[Developer Guide](./docs/developer-guide.md#installation)** and **[User Guide - Docker](./docs/user-guide.md#running-yasgui-with-docker)**.
142
+ For detailed installation instructions and usage examples, see the **[Developer Guide](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md#installation)** and **[User Guide - Docker](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#running-matgui-with-docker)**.
143
+
133
144
 
134
145
  ## Quick Start
135
146
 
@@ -173,7 +184,7 @@ const yasgui = new Yasgui(document.getElementById('yasgui'), {
173
184
 
174
185
  ### Authentication
175
186
 
176
- YASGUI supports multiple authentication methods for secure SPARQL endpoints:
187
+ Matgui supports multiple authentication methods for secure SPARQL endpoints:
177
188
 
178
189
  **Basic Authentication:**
179
190
  ```javascript
@@ -213,15 +224,15 @@ const yasgui = new Yasgui(document.getElementById('yasgui'), {
213
224
  });
214
225
  ```
215
226
 
216
- Authentication can also be configured through the UI via the Settings modal (gear icon). For detailed authentication documentation including dynamic auth and OAuth2, see the **[Developer Guide - Authentication](./docs/developer-guide.md#authentication)**.
227
+ Authentication can also be configured through the UI via the Settings modal (gear icon). For detailed authentication documentation including dynamic auth and OAuth2, see the **[Developer Guide - Authentication](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md#authentication)**.
217
228
 
218
- For framework-specific examples and advanced usage, see the **[Developer Guide](./docs/developer-guide.md#usage-examples)**.
229
+ For framework-specific examples and advanced usage, see the **[Developer Guide](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md#usage-examples)**.
219
230
 
220
231
  ---
221
232
 
222
233
  ## Configuration Options
223
234
 
224
- YASGUI is highly configurable. Here are some common configuration options:
235
+ Matgui is highly configurable. Here are some common configuration options:
225
236
 
226
237
  ```javascript
227
238
  const yasgui = new Yasgui(document.getElementById('yasgui'), {
@@ -249,7 +260,7 @@ const yasgui = new Yasgui(document.getElementById('yasgui'), {
249
260
  });
250
261
  ```
251
262
 
252
- For complete configuration options, see the **[Developer Guide - Configuration](./docs/developer-guide.md#configuration)**.
263
+ For complete configuration options, see the **[Developer Guide - Configuration](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md#configuration)**.
253
264
 
254
265
  ---
255
266
 
@@ -263,7 +274,7 @@ If you encounter CORS errors when querying remote endpoints:
263
274
  2. **Configure the endpoint** - Some endpoints support CORS with proper configuration
264
275
  3. **Server-side queries** - Execute queries server-side and display results client-side
265
276
 
266
- See the **[User Guide - CORS Errors](./docs/user-guide.md#cors-errors)** for detailed solutions.
277
+ See the **[User Guide - CORS Errors](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#cors-errors)** for detailed solutions.
267
278
 
268
279
  ### Local Endpoint Access
269
280
 
@@ -276,7 +287,7 @@ docker run -p 3030:3030 stain/jena-fuseki
276
287
 
277
288
  Access at: `http://localhost:3030/dataset/sparql`
278
289
 
279
- For more details, see **[User Guide - Querying Local Endpoints](./docs/user-guide.md#querying-local-endpoints)**.
290
+ For more details, see **[User Guide - Querying Local Endpoints](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md#querying-local-endpoints)**.
280
291
 
281
292
  ---
282
293
 
@@ -294,8 +305,8 @@ We welcome contributions! To get started:
294
305
  **📋 For detailed contribution guidelines, including our plugin development policy, see [CONTRIBUTING.md](./CONTRIBUTING.md).**
295
306
 
296
307
  Additional resources:
297
- - **[Developer Guide](./docs/developer-guide.md)** - API reference and integration guide
298
- - **[Plugin Development](./docs/developer-guide.md#plugin-development)** - How to create plugins
308
+ - **[Developer Guide](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md)** - API reference and integration guide
309
+ - **[Plugin Development](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md#plugin-development)** - How to create plugins
299
310
 
300
311
  ---
301
312
 
@@ -303,10 +314,10 @@ Additional resources:
303
314
 
304
315
  ### Getting Help
305
316
 
306
- - 📖 **[User Guide](./docs/user-guide.md)** - Comprehensive usage documentation
307
- - 🛠️ **[Developer Guide](./docs/developer-guide.md)** - API reference and integration
308
- - 🐛 **[Issue Tracker](https://github.com/Matdata-eu/Yasgui/issues)** - Report bugs or request features
309
- - 💬 **[Discussions](https://github.com/Matdata-eu/Yasgui/discussions)** - Ask questions and share ideas
317
+ - 📖 **[User Guide](https://github.com/Matdata-eu/Matgui/blob/main/docs/user-guide.md)** - Comprehensive usage documentation
318
+ - 🛠️ **[Developer Guide](https://github.com/Matdata-eu/Matgui/blob/main/docs/developer-guide.md)** - API reference and integration
319
+ - 🐛 **[Issue Tracker](https://github.com/Matdata-eu/Matgui/issues)** - Report bugs or request features
320
+ - 💬 **[Discussions](https://github.com/Matdata-eu/Matgui/discussions)** - Ask questions and share ideas
310
321
 
311
322
  ### Reporting Issues
312
323
 
@@ -323,9 +334,15 @@ When reporting issues, please include:
323
334
 
324
335
  MIT License - see [LICENSE](./LICENSE) file for details.
325
336
 
326
- ### Credits
337
+ ### Attribution & Acknowledgements
338
+
339
+ MatGUI stands on the shoulders of the **Yasgui** project and gratefully acknowledges its origins.
340
+
341
+ - The project began as a fork of [Zazuko/Yasgui](https://github.com/zazuko/Yasgui), which was itself forked from the original [Triply/Yasgui](https://github.com/TriplyDB/Yasgui) created by **Laurens Rietveld** and the Triply team.
342
+ - The name “Yasgui” (Yet Another SPARQL GUI) and the original YASQE/YASR components were created and maintained by those teams and their contributors. We thank every original author and contributor for their foundational work on SPARQL tooling for the web.
343
+ - MatGUI has since evolved substantially — with new features, a modernised codebase, and an expanded scope — and is developed and maintained independently by [Matdata](https://matdata.eu).
327
344
 
328
- This is a fork from [Zazuko](https://github.com/zazuko/Yasgui) who forked it from [Triply](https://github.com/TriplyDB/Yasgui).
345
+ **MatGUI is not affiliated with, endorsed by, or an official continuation of the rdfjs-, Zazuko-, or Triply-maintained Yasgui projects.** It is an independent project that honours its heritage while charting its own direction. For details on how the projects relate, see the [Rebranding & migration Guide](./docs/rebranding-to-matgui.md).
329
346
 
330
347
  **Maintained by:** [Matdata](https://matdata.eu)
331
348
 
@@ -333,6 +350,6 @@ This is a fork from [Zazuko](https://github.com/zazuko/Yasgui) who forked it fro
333
350
 
334
351
  ## Release Notes & Changelog
335
352
 
336
- Release notes and changelog are available in the [Releases](https://github.com/Matdata-eu/Yasgui/releases) section.
353
+ Release notes and changelog are available in the [Releases](https://github.com/Matdata-eu/Matgui/releases) section.
337
354
 
338
- For instructions on writing release notes, see [release-note-instructions.md](./docs/release-note-instructions.md).
355
+ For instructions on writing release notes, see [release-note-instructions.md](./docs/release-note-instructions.md).
package/package.json CHANGED
@@ -1,16 +1,16 @@
1
1
  {
2
2
  "name": "@matdata/yasgui-utils",
3
- "version": "5.20.3",
4
- "description": "Utils for YASGUI libs",
3
+ "version": "6.0.0",
4
+ "description": "Shared utilities for MatGUI (formerly Yasgui) packages.",
5
5
  "main": "build/utils.min.js",
6
6
  "types": "build/ts/src/index.d.ts",
7
7
  "license": "MIT",
8
8
  "author": "Triply <info@triply.cc>",
9
9
  "homepage": "https://github.com/Matdata-eu/Yasgui",
10
- "bugs": "https://github.com/Matdata-eu/Yasgui/issues",
10
+ "bugs": "https://github.com/Matdata-eu/Matgui/issues",
11
11
  "repository": {
12
12
  "type": "git",
13
- "url": "https://github.com/Matdata-eu/Yasgui.git",
13
+ "url": "https://github.com/Matdata-eu/Matgui.git",
14
14
  "directory": "packages/utils"
15
15
  },
16
16
  "dependencies": {