shaclc-writer

Write RDF/JS quads to SHACLC documents

Usage

import { Parser } from 'n3';
import { write } from 'shaclc-write';

const ttl = `
@base <http://example.org/array-in> .
@prefix ex: <http://example.org/test#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

<>
	a owl:Ontology ;
.

ex:TestShape
	a sh:NodeShape ;
	sh:property [
		sh:path ex:property ;
		sh:in ( ex:Instance1 true "string" 42 ) ;
	] ;
.
`

async function main() {
  const quads = (new Parser()).parse(ttl);

  const { text } = await write(quads, {
    prefixes: {
      ex: "http://example.org/test#",
      sh: "http://www.w3.org/ns/shacl#",
      owl: "http://www.w3.org/2002/07/owl#"
    }
  });


  // BASE <http://example.org/array-in>
  // PREFIX ex: <http://example.org/test#>
  //
  // shape ex:TestShape {
  // 	ex:property in=[ex:Instance1 true "string" 42] .
  // }
  console.log(text)
}

main();

Identifying quads that could not be serialized

By default an error is thrown if there are quads that cannot be serialised in SHACLC. Alternatively we can skip throwing errors and just return the quads that cannot be serialised.

import { Parser } from 'n3';
import { write } from 'shaclc-write';

const ttl = `
@base <http://example.org/array-in> .
@prefix ex: <http://example.org/test#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

<>
	a owl:Ontology ;
.

ex:TestShape
	a sh:NodeShape ;
	sh:property [
		sh:path ex:property ;
		sh:in ( ex:Instance1 true "string" 42 ) ;
	] ;
.

ex:Jesse ex:knows ex:Bob .

`

async function main() {
  const quads = (new Parser()).parse(ttl);

  const { text, extraQuads } = await write(quads, {
    prefixes: {
      ex: "http://example.org/test#",
      sh: "http://www.w3.org/ns/shacl#",
      owl: "http://www.w3.org/2002/07/owl#"
    },
    errorOnUnused: false
  });


  // BASE <http://example.org/array-in>
  // PREFIX ex: <http://example.org/test#>
  //
  // shape ex:TestShape {
  // 	ex:property in=[ex:Instance1 true "string" 42] .
  // }
  console.log(text)

  // Array containing a single RDF/JS representing the triple "ex:Jesse ex:knows ex:Bob"
  console.log(extraQuads)
}

main();

Minting prefixes

Prefixes for namespaces that have not been specified can also be created on demand (first it attempts to look up a prefix on prefix.cc and will generate one if this fails).

async function main() {
  const quads = (new Parser()).parse(ttl);

  const { text } = await write(quads, {
    mintPrefixes: true,
  });


  // BASE <http://example.org/array-in>
  // PREFIX test: <http://example.org/test#>
  //
  // shape test:TestShape {
  // 	test:property in=[test:Instance1 true "string" 42] .
  // }
  console.log(text)

  // Array containing a single RDF/JS representing the triple "ex:Jesse ex:knows ex:Bob"
  console.log(extraQuads)
}

main();

Extended SHACL Compact Syntax

The SHACL Compact Syntax specification is not expressive enough to make any RDF 1.0 statement. This package includes an opt-in extended syntax that allows users to make any RDF 1.0 statement. Writing of this extended syntax can be enabled via an option in the write function

const quads = write(/*quads*/, { extendedSyntax: true })

Making additional statements about the NodeShape

Additional statements can be made about NodeShapes by using a turtle-like syntax before the body of the shape. For instance we can add the following statements to the above ex:TestShape.

ex:TestShape ex:myCustomAnnotation ex:myCustomValue ;
	ex:myCustomBlankNodeAnnotation [
		ex:myCustomList ( 1 ex:myCustomValue )
	] .

by doing the following:

shape ex:TestShape -> ex:TestClass1 ex:TestClass2 ;
	ex:myCustomAnnotation ex:myCustomValue ;
	ex:myCustomBlankNodeAnnotation [
		ex:myCustomList ( 1 ex:myCustomValue )
	] {
		targetNode=ex:TestNode targetSubjectsOf=ex:subjectProperty targetObjectsOf=ex:objectProperty .
	}

Making additional statements about the sh:property

additional statements can be made about each blank node property as follows:

shape ex:TestShape -> ex:TestClass1 ex:TestClass2 {
	ex:myPath [0..1] %
		ex:myCustomPropertyAnnotation ex:myCustomPropertyValue ;
		ex:myCustomPropertyAnnotation2 ex:myCustomPropertyValue2 ;
	% .
}

Making arbitrary statements

Finally we permit the use of turtle syntax at the end of the file to make any additional statements

shape ex:TestShape -> ex:TestClass1 ex:TestClass2 {
	targetNode=ex:TestNode targetSubjectsOf=ex:subjectProperty targetObjectsOf=ex:objectProperty .
}

ex:bob a ex:Person .