feat: enable to define query used to retrieve examples when defining the html elements

Author: vemonet

packages/sparql-editor/src/metadata.ts

@@ -265,21 +265,23 @@ export async function getPredicatesFallback(endpoint: string) {
   return ["http://www.w3.org/1999/02/22-rdf-syntax-ns#type", "http://www.w3.org/2000/01/rdf-schema#label"];
 }
 
+const DEFAULT_QUERY_GET_EXAMPLES = `PREFIX sh: <http://www.w3.org/ns/shacl#>
+PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+SELECT DISTINCT ?sq ?comment ?query
+WHERE {
+  ?sq a sh:SPARQLExecutable ;
+    rdfs:comment ?comment ;
+    sh:select|sh:ask|sh:construct|sh:describe ?query .
+} ORDER BY ?sq`;
+
 // Retrieve example queries from the SPARQL endpoint
-export async function getExampleQueries(endpoint: string): Promise<ExampleQuery[]> {
+export async function getExampleQueries(
+  endpoint: string,
+  queryToGetExamples: string = DEFAULT_QUERY_GET_EXAMPLES,
+): Promise<ExampleQuery[]> {
   const exampleQueries: ExampleQuery[] = [];
   try {
-    const queryResults = await queryEndpointMeta(
-      `PREFIX sh: <http://www.w3.org/ns/shacl#>
-      PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
-      SELECT DISTINCT ?sq ?comment ?query
-      WHERE {
-        ?sq a sh:SPARQLExecutable ;
-          rdfs:comment ?comment ;
-          sh:select|sh:ask|sh:construct|sh:describe ?query .
-      } ORDER BY ?sq`,
-      endpoint,
-    );
+    const queryResults = await queryEndpointMeta(endpoint, queryToGetExamples);
     queryResults.forEach((b, index) => {
       exampleQueries.push({comment: b.comment.value, query: b.query.value, index: index + 1, iri: b.sq.value});
     });

packages/sparql-editor/src/sparql-editor.ts

@@ -59,6 +59,7 @@ export class SparqlEditor extends HTMLElement {
   examplesRepoAddUrl: string | undefined;
   addLimit: number | undefined;
   dialogElOpen: HTMLDialogElement | undefined;
+  queryToGetExamples: string | undefined;
   // TODO: make exampleQueries a dict with the query IRI as key, so if the window.location matches a key, it will load the query?
 
   constructor() {
@@ -121,7 +122,11 @@ export class SparqlEditor extends HTMLElement {
           this.meta[endpoint].classes,
           this.meta[endpoint].predicates,
         ],
-      ] = await Promise.all([getExampleQueries(endpoint), getPrefixes(endpoint), getVoidDescription(endpoint)]);
+      ] = await Promise.all([
+        getExampleQueries(endpoint, this.queryToGetExamples),
+        getPrefixes(endpoint),
+        getVoidDescription(endpoint),
+      ]);
       this.meta[endpoint].retrievedAt = new Date().toISOString();
 
       if (Object.keys(this.meta[endpoint].prefixes).length === 0) {
@@ -201,6 +206,8 @@ export class SparqlEditor extends HTMLElement {
     this.endpoints = (this.getAttribute("endpoint") || "").split(",").map(e => e.trim());
     this.meta = this.loadMetaFromLocalStorage();
 
+    this.queryToGetExamples = this.getAttribute("query-to-get-examples") || undefined;
+
     // NOTE: will need to be removed at some point I guess
     // Check if examples contain the index field, if not reset cache
     if (this.currentEndpoint() && this.currentEndpoint().examples?.some(example => example.iri === undefined)) {