@ulb-darmstadt/shacl-form 1.8.3 → 1.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ulb-darmstadt/shacl-form",
-    "version": "1.8.3",
+    "version": "1.9.0",
     "description": "SHACL form generator",
     "main": "dist/form-default.js",
     "module": "dist/form-default.js",
@@ -55,7 +55,7 @@
         "@types/uuid": "^10.0.0",
         "rollup-plugin-peer-deps-external": "^2.2.4",
         "typescript": "^5.8.3",
-        "vite": "^7.0.4",
+        "vite": "^7.0.5",
         "vite-plugin-dts": "^4.5.4"
     },
     "dependencies": {
@@ -67,11 +67,12 @@
         "leaflet.fullscreen": "^4.0.0",
         "mapbox-gl": "^3.13.0",
         "n3": "^1.26.0",
+        "rdfxml-streaming-parser": "^3.1.0",
         "shacl-engine": "^1.0.2",
         "uuid": "^11.1.0"
     },
     "peerDependencies": {
-        "@ro-kit/ui-widgets": "^0.0.31",
+        "@ro-kit/ui-widgets": "^0.0.33",
         "mdui": "^2.1.4"
     }
 }

package/src/loader.ts

@@ -1,14 +1,17 @@
-import { Store, Parser, Quad, Prefixes, NamedNode, DataFactory } from 'n3'
-import { toRDF } from 'jsonld'
+import { Store, Quad, NamedNode, DataFactory, Parser, Prefixes } from 'n3'
 import { DATA_GRAPH, DCTERMS_PREDICATE_CONFORMS_TO, OWL_PREDICATE_IMPORTS, RDF_PREDICATE_TYPE, SHACL_PREDICATE_CLASS, SHAPES_GRAPH } from './constants'
 import { Config } from './config'
 import { isURL } from './util'
+import { RdfXmlParser } from 'rdfxml-streaming-parser'
+import { toRDF } from 'jsonld'
+
 
 // cache external data in module scope (and not in Loader instance) to avoid requesting
 // them multiple times, e.g. when more than one shacl-form element is on the page
 // that import the same resources
 const loadedURLCache: Record<string, Promise<string>> = {}
 const loadedClassesCache: Record<string, Promise<string>> = {}
+const ttlParser = new Parser()
 let sharedShapesGraph: Store | undefined
 
 export class Loader {
@@ -31,9 +34,9 @@ export class Loader {
         const promises: Promise<void>[] = []
         if (!store) {
             store = new Store()
-            promises.push(this.importRDF(this.config.attributes.shapes ? this.config.attributes.shapes : this.config.attributes.shapesUrl ? this.fetchRDF(this.config.attributes.shapesUrl) : '', store, SHAPES_GRAPH))
+            promises.push(this.importRDF(this.config.attributes.shapes ? this.config.attributes.shapes : this.config.attributes.shapesUrl ? fetchRDF(this.config.attributes.shapesUrl) : '', store, SHAPES_GRAPH))
         }
-        promises.push(this.importRDF(this.config.attributes.values ? this.config.attributes.values : this.config.attributes.valuesUrl ? this.fetchRDF(this.config.attributes.valuesUrl) : '', store, DATA_GRAPH, new Parser({ blankNodePrefix: '' })))
+        promises.push(this.importRDF(this.config.attributes.values ? this.config.attributes.values : this.config.attributes.valuesUrl ? fetchRDF(this.config.attributes.valuesUrl) : '', store, DATA_GRAPH))
         await Promise.all(promises)
 
         // if shapes graph is empty, but we have the following triples:
@@ -49,7 +52,7 @@ export class Loader {
                 const url = this.toURL(uri.value)
                 if (url && this.loadedExternalUrls.indexOf(url) < 0) {
                     this.loadedExternalUrls.push(url)
-                    promises.push(this.importRDF(this.fetchRDF(url), store, SHAPES_GRAPH))
+                    promises.push(this.importRDF(fetchRDF(url), store, SHAPES_GRAPH))
                 }
             }
             try {
@@ -62,52 +65,77 @@ export class Loader {
         this.config.store = store
     }
     
-    async importRDF(input: string | Promise<string>, store: Store, graph?: NamedNode, parser?: Parser) {
-        const p = parser || new Parser()
-        const parse = async (text: string) => {
+    async importRDF(input: string | Promise<string>, store: Store, graph?: NamedNode) {
+        const parse = async (input: string) => {
             const dependencies: Promise<void>[] = []
             await new Promise((resolve, reject) => {
-                p.parse(text, (error: Error, quad: Quad, prefixes: Prefixes) => {
-                    if (error) {
-                        console.warn('failed parsing graph', graph, error.message)
-                        return reject(error)
-                    }
-                    if (quad) {
-                        store.add(new Quad(quad.subject, quad.predicate, quad.object, graph))
-                        // check if this is an owl:imports predicate and try to load the url
-                        if (this.config.attributes.ignoreOwlImports === null && OWL_PREDICATE_IMPORTS.equals(quad.predicate)) {
-                            const url = this.toURL(quad.object.value)
-                            // import url only once
-                            if (url && this.loadedExternalUrls.indexOf(url) < 0) {
-                                this.loadedExternalUrls.push(url)
-                                // import into separate graph
-                                dependencies.push(this.importRDF(this.fetchRDF(url), store, DataFactory.namedNode(url), parser))
-                            }
+                const addQuad = (quad: Quad) => {
+                    store.add(new Quad(quad.subject, quad.predicate, quad.object, graph))
+                    // check if this is an owl:imports predicate and try to load the url
+                    if (this.config.attributes.ignoreOwlImports === null && OWL_PREDICATE_IMPORTS.equals(quad.predicate)) {
+                        const url = this.toURL(quad.object.value)
+                        // import url only once
+                        if (url && this.loadedExternalUrls.indexOf(url) < 0) {
+                            this.loadedExternalUrls.push(url)
+                            // import into separate graph
+                            dependencies.push(this.importRDF(fetchRDF(url), store, DataFactory.namedNode(url)))
                         }
-                        // check if this is an sh:class predicate and invoke class instance provider
-                        if (this.config.classInstanceProvider && SHACL_PREDICATE_CLASS.equals(quad.predicate)) {
-                            const className = quad.object.value
-                            // import class definitions only once
-                            if (this.loadedClasses.indexOf(className) < 0) {
-                                let promise: Promise<string>
-                                // check if class is in module scope cache
-                                if (className in loadedClassesCache) {
-                                    promise = loadedClassesCache[className]
-                                } else {
-                                    promise = this.config.classInstanceProvider(className)
-                                    loadedClassesCache[className] = promise
-                                }
-                                this.loadedClasses.push(className)
-                                dependencies.push(this.importRDF(promise, store, graph, parser))
+                    }
+                    // check if this is an sh:class predicate and invoke class instance provider
+                    if (this.config.classInstanceProvider && SHACL_PREDICATE_CLASS.equals(quad.predicate)) {
+                        const className = quad.object.value
+                        // import class definitions only once
+                        if (this.loadedClasses.indexOf(className) < 0) {
+                            let promise: Promise<string>
+                            // check if class is in module scope cache
+                            if (className in loadedClassesCache) {
+                                promise = loadedClassesCache[className]
+                            } else {
+                                promise = this.config.classInstanceProvider(className)
+                                loadedClassesCache[className] = promise
                             }
+                            this.loadedClasses.push(className)
+                            dependencies.push(this.importRDF(promise, store, graph))
                         }
-                        return
                     }
-                    if (prefixes) {
-                        this.config.registerPrefixes(prefixes)
-                    }
-                    resolve(null)
-                })
+                }
+                const type = guessContentType(input)
+                if (type === 'xml') {
+                    const parser = new RdfXmlParser()
+                    parser.on('data', (quad: Quad) => {
+                        addQuad(quad)
+                    })
+                    .on('error', (error) => {
+                        console.warn('failed parsing graph', graph, error.message)
+                        reject(error)
+                    })
+                    .on('prefix', (prefix, iri) => {
+                        // ignore empty (default) namespace
+                        if (prefix) {
+                            this.config.prefixes[prefix] = iri
+                        }
+                    })
+                    .on('end', () => {
+                        resolve(null)
+                    })
+                    parser.write(input)
+                    parser.end()
+                } else {
+                    ttlParser.parse(input, (error: Error, quad: Quad, prefixes: Prefixes) => {
+                        if (error) {
+                            console.warn('failed parsing graph', graph, error.message)
+                            return reject(error)
+                        }
+                        if (quad) {
+                            addQuad(quad)
+                            return
+                        }
+                        if (prefixes) {
+                            this.config.registerPrefixes(prefixes)
+                        }
+                        resolve(null)
+                    })                
+                }
             })
             try {
                 await Promise.allSettled(dependencies)
@@ -120,31 +148,18 @@ export class Loader {
             input = await input
         }
         if (input) {
-            try {
-                // check if input is JSON
-                // @ts-ignore, because result of toRDF is a string and not an object
-                input = await toRDF(JSON.parse(input), { format: 'application/n-quads' }) as string
-            } catch(_) {
-                // NOP, it wasn't JSON
+            if (guessContentType(input) === 'json') {
+                // convert json to n-quads
+                try {
+                    input = await toRDF(JSON.parse(input), { format: 'application/n-quads' }) as string
+                } catch(e) {
+                    console.error(e)
+                }
             }
             await parse(input)
         }
     }
 
-    async fetchRDF(url: string): Promise<string> {
-        // try to load from cache first
-        if (url in loadedURLCache) {
-            return loadedURLCache[url]
-        }
-        const promise = fetch(url, {
-            headers: {
-                'Accept': 'text/turtle, application/trig, application/n-triples, application/n-quads, text/n3, application/ld+json'
-            },
-        }).then(resp => resp.text())
-        loadedURLCache[url] = promise
-        return promise
-    }
-
     toURL(id: string): string | null {
         if (isURL(id)) {
             return id
@@ -165,6 +180,31 @@ export class Loader {
         }
         return null
     }
+
+}
+
+async function fetchRDF(url: string): Promise<string> {
+    // try to load from cache first
+    if (url in loadedURLCache) {
+        return loadedURLCache[url]
+    }
+    const promise = fetch(url, {
+        headers: {
+            'Accept': 'text/turtle, application/trig, application/n-triples, application/n-quads, text/n3, application/ld+json'
+        },
+    }).then(resp => resp.text())
+    loadedURLCache[url] = promise
+    return promise
+}
+
+/* Can't rely on HTTP content-type header, since many resources are delivered with text/plain */
+function guessContentType(input: string) {
+    if (/^\s*\{/.test(input)) {
+        return 'json'
+    } else if (/^\s*<\?xml/.test(input)) {
+        return 'xml'
+    } 
+    return 'ttl'
 }
 
 export function setSharedShapesGraph(graph: Store) {

package/src/util.ts

@@ -1,4 +1,4 @@
-import { Literal, NamedNode, Prefixes, Quad, Term as N3Term, Store } from 'n3'
+import { Literal, NamedNode, Prefixes, Quad, Store } from 'n3'
 import { DATA_GRAPH, PREFIX_FOAF, PREFIX_RDFS, PREFIX_SHACL, PREFIX_SKOS, RDFS_PREDICATE_SUBCLASS_OF, RDF_PREDICATE_TYPE, SHAPES_GRAPH, SKOS_PREDICATE_BROADER, SKOS_PREDICATE_NARROWER } from './constants'
 import { Term } from '@rdfjs/types'
 import { InputListEntry } from './theme'
@@ -88,32 +88,47 @@ export function findInstancesOf(clazz: NamedNode, template: ShaclPropertyTemplat
         const list = template.config.lists[template.shaclIn]
         return createInputListEntries(list?.length ? list : [], template.config.store, template.config.languages)
     } else {
+        // find instances in the shapes graph
         const instances = template.config.store.getSubjects(RDF_PREDICATE_TYPE, clazz, SHAPES_GRAPH)
         // find instances in the data graph
         instances.push(...template.config.store.getSubjects(RDF_PREDICATE_TYPE, clazz, DATA_GRAPH))
         // find instances in imported taxonomies
         findClassInstancesFromOwlImports(clazz, template, template.config.store, instances)
 
-        // structures needed for build a class instance hierarchy
+        // initialize structures needed for building a class instance hierarchy
         const nodes = new Map<string, InputListEntry>()   // URI -> InputListEntry
         const childToParent = new Map<string, string>() // URI -> parentURI
 
-        // Step 1: Initialize all instances as InputListEntry's with no children
+        // initialize all instances as InputListEntry's with no children
         for (const instance of instances) {
             nodes.set(instance.id, { value: instance, label: findLabel(template.config.store.getQuads(instance, null, null, null), template.config.languages), children: [] })
         }
 
-        // Step 2: Record broader/narrower relationships (child -> parent)
+        // record broader/narrower/subClassOf hierarchical relationships
         for (const instance of instances) {
-            appendSkosBroaderNarrower(instance, nodes, childToParent, template)
+            for (const parent of template.config.store.getObjects(instance, SKOS_PREDICATE_BROADER, null)) {
+                if (nodes.has(parent.id)) {
+                    childToParent.set(instance.id, parent.id)
+                }
+            }
+            for (const child of template.config.store.getObjects(instance, SKOS_PREDICATE_NARROWER, null)) {
+                if (nodes.has(child.id)) {
+                    childToParent.set(child.id, instance.id)
+                }
+            }
+            for (const parent of template.config.store.getObjects(instance, RDFS_PREDICATE_SUBCLASS_OF, null)) {
+                if (nodes.has(parent.id)) {
+                    childToParent.set(instance.id, parent.id)
+                }
+            }
         }
 
-        // Step 3: Build hierarchy by nesting children under parents
+        // build hierarchy by nesting children under parents
         for (const [child, parent] of childToParent.entries()) {
-            nodes.get(parent)!.children!.push(nodes.get(child)!)
+            nodes.get(parent)?.children?.push(nodes.get(child)!)
         }
 
-        // Step 4: Find root nodes (no broader relationship)
+        // find root nodes (no parent relationship)
         const roots: InputListEntry[] = []
         for (const [uri, node] of nodes.entries()) {
             if (!childToParent.has(uri)) {
@@ -121,7 +136,7 @@ export function findInstancesOf(clazz: NamedNode, template: ShaclPropertyTemplat
             }
         }
 
-        // Step 5: Add sub class instances
+        // add sub class instances
         for (const subClass of template.config.store.getSubjects(RDFS_PREDICATE_SUBCLASS_OF, clazz, null)) {
             roots.push(...findInstancesOf(subClass as NamedNode, template))
         }
@@ -129,23 +144,6 @@ export function findInstancesOf(clazz: NamedNode, template: ShaclPropertyTemplat
     }
 }
 
-function appendSkosBroaderNarrower(subject: N3Term, nodes: Map<string, InputListEntry>, childToParent: Map<string, string>, template: ShaclPropertyTemplate) {
-    for (const parent of template.config.store.getObjects(subject, SKOS_PREDICATE_BROADER, null)) {
-        childToParent.set(subject.id, parent.id)
-        if (!nodes.has(parent.id)) {
-            nodes.set(parent.id, { value: parent, label: findLabel(template.config.store.getQuads(parent, null, null, null), template.config.languages), children: [] })
-        }
-        appendSkosBroaderNarrower(parent, nodes, childToParent, template)
-    }
-    for (const child of template.config.store.getObjects(subject, SKOS_PREDICATE_NARROWER, null)) {
-        childToParent.set(child.id, subject.id)
-        if (!nodes.has(child.id)) {
-            nodes.set(child.id, { value: child, label: findLabel(template.config.store.getQuads(child, null, null, null), template.config.languages), children: [] })
-        }
-        appendSkosBroaderNarrower(child, nodes, childToParent, template)
-    }
-}
-
 export function isURL(input: string): boolean {
     let url: URL
     try {