@ulb-darmstadt/shacl-form 1.7.4 → 1.8.1

package/README.md

@@ -141,11 +141,14 @@ Apart from setting the element attributes `data-shapes` or `data-shapes-url`, th
     In this case, the URL references an ontology which among other things defines instances of class `prov:Role` that are then used to populate the "Role" dropdown in the form.
 
 2. <a id="classInstanceProvider"></a>The `<shacl-form>` element has a function `setClassInstanceProvider((className: string) => Promise<string>)` that registers a callback function which is invoked when a SHACL property has
-an `sh:class` predicate. The expected return value is a (promise of a) string (e.g. in format `text/turtle`) that contains RDF class instance definitions of the given class. Instances can be defined e.g. like:
-    - `example:Instance a example:Class`
-    - `example:Instance a owl:NamedIndividual; skos:broader example:Class`
+an `sh:class` predicate. The expected return value is a (promise of a) string (e.g. in format `text/turtle`) that contains RDF class instance definitions of the given class.
   
-    Class hierarchies can be built using `rdfs:subClassOf` or `skos:broader`.
+    Class hierarchies can be built using `rdfs:subClassOf`. Instance hierarchies can be modeled e.g. like:
+    ```
+    ex:parent a ex:Class .
+    ex:child rdfs:subClassOf ex:parent; a ex:parent .
+    ex:grandchild rdfs:subClassOf ex:child; a ex:child .
+    ```
     
     In [this example](https://ulb-darmstadt.github.io/shacl-form/#example), the code:
   
@@ -165,9 +168,9 @@ an `sh:class` predicate. The expected return value is a (promise of a) string (e
 
     A more realistic use case of this feature is calling some API endpoint to fetch class instance definitions from existing ontologies.
 
-### SHACL "or" constraint
+### SHACL "or" and "xone" constraint
 
-`<shacl-form>` supports using [sh:or](https://www.w3.org/TR/shacl/#OrConstraintComponent) to let users select between different options on nodes or properties.
+`<shacl-form>` supports using [sh:or](https://www.w3.org/TR/shacl/#OrConstraintComponent) and [sh:xone](https://www.w3.org/TR/shacl/#XoneConstraintComponent) to let users select between different options on nodes or properties.
 The [example shapes graph](https://ulb-darmstadt.github.io/shacl-form/#example) has the following triples:
 ```
 example:Attribution
@@ -184,10 +187,20 @@ example:Attribution
 ```
 When adding a new attribution, `<shacl-form>` renders a dropdown to let the user select between the two options Person/Organisation. After selecting one of the options, the dropdown is replaced by the input fields of the selected node shape.
 
-When binding an existing data graph to the form, the `sh:or` constraint is tried to be resolved depending on the respective data value:
+When binding an existing data graph to the form, the constraint is tried to be resolved depending on the respective data value:
 - For RDF literals, an `sh:or` option with a matching `sh:datatype` is chosen
 - For blank nodes or named nodes, the `rdf:type` of the value is tried to be matched with a node shape having a corresponding `sh:targetClass` or with a property shape having a corresponding `sh:class`. If there is no `rdf:type` but a `sh:nodeKind` of `sh:IRI`, the id of the the node is used as the value.
 
+### Linking existing data
+
+In case a node shape has a `sh:targetClass` and any graph, i.e.
+- the shapes graph
+- the data graph
+- any graph loaded by `owl:imports`
+- triples provided by [classInstanceProvider](#classInstanceProvider)
+
+contains instances of that class, those can be linked in the respective SHACL property. In effect, the generated data graph will just contain a reference to the instance, but not the triples that the instance consists of.
+
 ### SHACL shape inheritance
 
 SHACL defines two ways of inheriting shapes: [sh:and](https://www.w3.org/TR/shacl/#AndConstraintComponent)

package/dist/config.d.ts

@@ -32,18 +32,17 @@ export declare class Config {
     prefixes: Prefixes;
     editMode: boolean;
     languages: string[];
-    dataGraph: Store<import("@rdfjs/types").Quad, import("n3").Quad, import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>;
     lists: Record<string, Term[]>;
     groups: Array<string>;
     theme: Theme;
     form: HTMLElement;
     renderedNodes: Set<string>;
-    valuesGraph: NamedNode | undefined;
-    private _shapesGraph;
+    valuesGraphId: NamedNode | undefined;
+    private _store;
     constructor(theme: Theme, form: HTMLElement);
     updateAttributes(elem: HTMLElement): void;
     static dataAttributes(): Array<string>;
-    get shapesGraph(): Store;
-    set shapesGraph(graph: Store);
+    get store(): Store;
+    set store(store: Store);
     registerPrefixes(prefixes: Prefixes): void;
 }

package/dist/constants.d.ts

@@ -7,16 +7,16 @@ export declare const PREFIX_SKOS = "http://www.w3.org/2004/02/skos/core#";
 export declare const PREFIX_OWL = "http://www.w3.org/2002/07/owl#";
 export declare const PREFIX_OA = "http://www.w3.org/ns/oa#";
 export declare const PREFIX_DCTERMS = "http://purl.org/dc/terms/";
-export declare const SHAPES_GRAPH: import("n3").NamedNode<"shapes">;
-export declare const RDF_PREDICATE_TYPE: import("n3").NamedNode<string>;
-export declare const DCTERMS_PREDICATE_CONFORMS_TO: import("n3").NamedNode<string>;
-export declare const RDFS_PREDICATE_SUBCLASS_OF: import("n3").NamedNode<string>;
-export declare const SKOS_PREDICATE_BROADER: import("n3").NamedNode<string>;
-export declare const OWL_PREDICATE_IMPORTS: import("n3").NamedNode<string>;
-export declare const OWL_OBJECT_NAMED_INDIVIDUAL: import("n3").NamedNode<string>;
-export declare const SHACL_OBJECT_NODE_SHAPE: import("n3").NamedNode<string>;
-export declare const SHACL_OBJECT_IRI: import("n3").NamedNode<string>;
-export declare const SHACL_PREDICATE_PROPERTY: import("n3").NamedNode<string>;
-export declare const SHACL_PREDICATE_CLASS: import("n3").NamedNode<string>;
-export declare const SHACL_PREDICATE_TARGET_CLASS: import("n3").NamedNode<string>;
-export declare const SHACL_PREDICATE_NODE_KIND: import("n3").NamedNode<string>;
+export declare const PREFIX_FOAF = "http://xmlns.com/foaf/0.1/";
+export declare const SHAPES_GRAPH: import('n3').NamedNode<"loaded-shapes">;
+export declare const DATA_GRAPH: import('n3').NamedNode<"loaded-data">;
+export declare const RDF_PREDICATE_TYPE: import('n3').NamedNode<string>;
+export declare const DCTERMS_PREDICATE_CONFORMS_TO: import('n3').NamedNode<string>;
+export declare const RDFS_PREDICATE_SUBCLASS_OF: import('n3').NamedNode<string>;
+export declare const OWL_PREDICATE_IMPORTS: import('n3').NamedNode<string>;
+export declare const SHACL_OBJECT_NODE_SHAPE: import('n3').NamedNode<string>;
+export declare const SHACL_OBJECT_IRI: import('n3').NamedNode<string>;
+export declare const SHACL_PREDICATE_PROPERTY: import('n3').NamedNode<string>;
+export declare const SHACL_PREDICATE_CLASS: import('n3').NamedNode<string>;
+export declare const SHACL_PREDICATE_TARGET_CLASS: import('n3').NamedNode<string>;
+export declare const SHACL_PREDICATE_NODE_KIND: import('n3').NamedNode<string>;

package/dist/constraints.d.ts

@@ -1,7 +1,7 @@
 import { Quad } from 'n3';
 import { Term } from '@rdfjs/types';
-import { ShaclNode } from "./node";
-import { ShaclProperty } from "./property";
+import { ShaclNode } from './node';
+import { ShaclProperty } from './property';
 import { Config } from './config';
 export declare function createShaclOrConstraint(options: Term[], context: ShaclNode | ShaclProperty, config: Config): HTMLElement;
 export declare function resolveShaclOrConstraintOnProperty(subjects: Term[], value: Term, config: Config): Quad[];

package/dist/exports.d.ts

@@ -1,4 +1,5 @@
-export { Theme, InputListEntry, Editor } from './theme';
+export type { InputListEntry, Editor } from './theme';
+export { Theme } from './theme';
 export { Loader, setSharedShapesGraph } from './loader';
 export { Config } from './config';
 export { Plugin, registerPlugin } from './plugin';

package/dist/form-bootstrap.d.ts

@@ -1,4 +1,4 @@
-import { ShaclForm as FormBase } from "./form";
+import { ShaclForm as FormBase } from './form';
 export * from './exports';
 export declare class ShaclForm extends FormBase {
     constructor();