@ulb-darmstadt/shacl-form 1.1.2 → 1.1.4

package/README.md

@@ -38,22 +38,34 @@ This library provides an HTML5 web component that renders [SHACL shapes](https:/
 Attribute | Description
 ---|---
 data-shapes | SHACL shape definitions (e.g. a turtle string) to generate the form from
-data-shapes-url | When `data-shapes` is not set, load the shapes graph from this URL
+data-shapes-url | When `data-shapes` is not set, the shapes graph is loaded from this URL
 data-shape-subject | Optional subject (id) of the shacl node shape to use as root for the form. If not set, the first found shacl node shape will be used
 data-values | RDF triples (e.g. a turtle string) to use as existing data values in the generated form
-data-values-url | When `data-values` is not set, load the data graph from this URL
+data-values-url | When `data-values` is not set, the data graph is loaded from this URL
 data-value-subject | The subject (id) of the generated data. If this is not set, a blank node with a new UUID will be used. If `data-values` or `data-values-url` is set, this id is also used to find existing data in the data graph to fill the form
-data-language | Language to use if shapes contain langStrings
-data‑load‑owl‑imports | Whether to fetch RDF data from `owl:imports` statements. Default: `true`
-data-submit-button | Whether to append a submit button to the form. The string value of this attribute is used as the button label. Submit events will only fire after successful validation
+data-language | Language to use if shapes contain langStrings, e.g. in `sh:name` or `rdfs:label`
+data‑ignore‑owl‑imports | By default, `owl:imports` IRIs are fetched and the resulting triples added to the shapes graph. Set this attribute in order to disable this feature
+data-submit-button | Whether to append a submit button to the form. The string value of this attribute is used as the button label. `submit` events will only fire after successful validation
 
 ### Element functions
-Function | Description
----|---
-`serialize(format?: string): string \| {}[]` | Serializes the form data as RDF triples. Supported formats:  `text/turtle` (default), `application/ld+json`, `application/n-triples`, `application/n-quads`, `application/trig`
-`validate(ignoreEmptyValues: boolean): Promise\<boolean\>` | Validates the form data against the SHACL shapes graph and displays validation results as icons. If `ignoreEmptyValues` is true, empty form fields will not be marked as having validation errors
-`registerPlugin(plugin: Plugin)` | TBD
+```typescript
+serialize(format?: string): string | []
+```
+
+Serializes the form data as RDF triples. Supported formats:  `text/turtle` (default), `application/ld+json`, `application/n-triples`, `application/n-quads`, `application/trig`. Format `application/ld+json` returns a JSON array, all other formats return a string.
+
+```typescript
+validate(ignoreEmptyValues: boolean): Promise<boolean>
+```
+Validates the form data against the SHACL shapes graph and displays validation results as icons next to the respective input fields. If `ignoreEmptyValues` is true, empty form fields will not be marked as invalid. This function is also internally called on `change` and `submit` events.
+
+```typescript
+registerPlugin(plugin: Plugin)
+```
+WIP / TBD
 
-## Theming
-TBD
+```typescript
+setClassInstanceProvider((className: string) => Promise<string>)
+```
+Sets a callback function that is called when a SHACL property has a `sh:class` definition. The expected return value is a string (e.g. in format `text/turtle`) that contains RDF instance definitions of the given class name.
 

package/dist/config.d.ts

@@ -1,8 +1,8 @@
 import { Prefixes, Store } from 'n3';
 import { Term } from '@rdfjs/types';
-import { Theme } from './theme';
-import { Plugins } from './plugin';
-export declare class Config {
+import { ClassInstanceProvider, Plugins } from './plugin';
+import { Loader } from './loader';
+export declare class ElementAttributes {
     shapes: string | null;
     shapesUrl: string | null;
     shapeSubject: string | null;
@@ -10,27 +10,22 @@ export declare class Config {
     valuesUrl: string | null;
     valueSubject: string | null;
     language: string | null;
-    loadOwlImports: string;
+    ignoreOwlImports: string | null;
     submitButton: string | null;
-    private _theme;
-    private _lists;
-    private _groups;
+}
+export declare class Config {
+    attributes: ElementAttributes;
+    loader: Loader;
+    classInstanceProvider: ClassInstanceProvider | undefined;
+    prefixes: Prefixes;
+    plugins: Plugins;
+    dataGraph: Store<import("@rdfjs/types").Quad, import("n3").Quad, import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>;
+    lists: Record<string, Term[]>;
+    groups: Array<string>;
     private _shapesGraph;
-    private _dataGraph;
-    private _plugins;
-    private _prefixes;
-    equals(other: Config): boolean;
+    updateAttributes(elem: HTMLElement): void;
+    static dataAttributes(): Array<string>;
     get shapesGraph(): Store;
     set shapesGraph(graph: Store);
-    get dataGraph(): Store;
-    set dataGraph(graph: Store);
-    get lists(): Record<string, Term[]>;
-    get groups(): string[];
-    set theme(theme: Theme);
-    get prefixes(): Prefixes<import("@rdfjs/types").NamedNode<string>>;
     registerPrefixes(prefixes: Prefixes): void;
-    get plugins(): Plugins;
-    set plugins(plugins: Plugins);
-    static from(elem: HTMLElement): Config;
-    static get keysAsDataAttributes(): Array<string>;
 }

package/dist/constants.d.ts

@@ -10,3 +10,4 @@ export declare const OWL_IMPORTS: import("n3").NamedNode<string>;
 export declare const RDF_PREDICATE_TYPE: import("n3").NamedNode<string>;
 export declare const RDFS_PREDICATE_SUBCLASS_OF: import("n3").NamedNode<string>;
 export declare const SHACL_OBJECT_NODE_SHAPE: import("n3").NamedNode<string>;
+export declare const SHACL_PREDICATE_CLASS: import("n3").NamedNode<string>;

package/dist/constraints.d.ts

@@ -2,6 +2,4 @@ import { Term } from '@rdfjs/types';
 import { ShaclNode } from "./node";
 import { ShaclProperty } from "./property";
 import { Config } from './config';
-export declare class ShaclOrConstraint extends HTMLElement {
-    constructor(options: Term[], context: ShaclNode | ShaclProperty, config: Config);
-}
+export declare function createShaclOrConstraint(options: Term[], context: ShaclNode | ShaclProperty, config: Config): HTMLElement;

package/dist/editors.d.ts

@@ -0,0 +1,19 @@
+import { Literal, NamedNode } from 'n3';
+import { Term } from '@rdfjs/types';
+import { ShaclPropertyTemplate } from './property-template';
+export type Editor = HTMLElement & {
+    value: string;
+};
+export declare function createDefaultTemplate(template: ShaclPropertyTemplate, editor: Editor, value?: Term): HTMLElement;
+export declare function createDateEditor(template: ShaclPropertyTemplate, value?: Term): HTMLElement;
+export declare function createTextEditor(template: ShaclPropertyTemplate, value?: Term): HTMLElement;
+export declare function createLangStringEditor(template: ShaclPropertyTemplate, value?: Term): HTMLElement;
+export declare function createBooleanEditor(template: ShaclPropertyTemplate, value?: Term): HTMLElement;
+export declare function createNumberEditor(template: ShaclPropertyTemplate, value?: Term): HTMLElement;
+export type InputListEntry = {
+    value: Term;
+    label?: string;
+};
+export declare function createListEditor(template: ShaclPropertyTemplate, listEntries: InputListEntry[], value?: Term): HTMLElement;
+export declare function toRDF(editor: Editor): Literal | NamedNode | undefined;
+export declare function editorFactory(template: ShaclPropertyTemplate, value?: Term): HTMLElement;

package/dist/form.d.ts

@@ -1,12 +1,10 @@
 import { ShaclNode } from './node';
 import { Config } from './config';
-import { Plugin } from './plugin';
+import { ClassInstanceProvider, Plugin } from './plugin';
 import './styles.css';
-import { Loader } from './loader';
 export declare class ShaclForm extends HTMLElement {
     static get observedAttributes(): string[];
     config: Config;
-    loader: Loader;
     shape: ShaclNode | null;
     form: HTMLFormElement;
     initDebounceTimeout: ReturnType<typeof setTimeout> | undefined;
@@ -16,6 +14,7 @@ export declare class ShaclForm extends HTMLElement {
     private initialize;
     serialize(format?: string): string | {}[];
     registerPlugin(plugin: Plugin): void;
+    setClassInstanceProvider(provider: ClassInstanceProvider): void;
     validate(ignoreEmptyValues?: boolean): Promise<boolean>;
     private createValidationErrorDisplay;
     private findRootShaclShapeSubject;

package/dist/group.d.ts

@@ -1,4 +1,2 @@
 import { Config } from './config';
-export declare class ShaclGroup extends HTMLElement {
-    constructor(groupSubject: string, config: Config);
-}
+export declare function createShaclGroup(groupSubject: string, config: Config): HTMLElement;