@lde/pipeline-shacl-validator 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export type { Validator, ValidationReport, ValidationResult, } from '@lde/pipeline';
+export type { Validator, ValidationReport, ValidationResult, SerializationFormat, } from '@lde/pipeline';
 export { ShaclValidator, type ShaclValidatorOptions, } from './shacl-validator.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,cAAc,EACd,KAAK,qBAAqB,GAC3B,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,cAAc,EACd,KAAK,qBAAqB,GAC3B,MAAM,sBAAsB,CAAC"}

package/dist/shacl-validator.d.ts

@@ -1,12 +1,15 @@
 import type { Quad } from '@rdfjs/types';
 import type { Dataset } from '@lde/dataset';
 import type { Validator, ValidationResult, ValidationReport } from '@lde/pipeline';
+import { type SerializationFormat } from '@lde/pipeline';
 /** Options for {@link ShaclValidator}. */
 export interface ShaclValidatorOptions {
     /** Path to an RDF file containing SHACL shapes (any format supported by rdf-dereference). */
     shapesFile: string;
     /** Directory for validation report files. */
     reportDir: string;
+    /** Serialization format for report files. @default 'Turtle' */
+    reportFormat?: SerializationFormat;
 }
 /**
  * SHACL-based {@link Validator} for `@lde/pipeline`.
@@ -18,6 +21,7 @@ export interface ShaclValidatorOptions {
 export declare class ShaclValidator implements Validator {
     private readonly shapesFile;
     private readonly reportDir;
+    private readonly reportFormat;
     private shapesDataset;
     private readonly accumulators;
     constructor(options: ShaclValidatorOptions);

package/dist/shacl-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shacl-validator.d.ts","sourceRoot":"","sources":["../src/shacl-validator.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAQvB,0CAA0C;AAC1C,MAAM,WAAW,qBAAqB;IACpC,6FAA6F;IAC7F,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;CACnB;AAQD;;;;;;GAMG;AACH,qBAAa,cAAe,YAAW,SAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC,OAAO,CAAC,aAAa,CAAkB;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyC;gBAE1D,OAAO,EAAE,qBAAqB;IAKpC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAmCpE,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;YAc3C,SAAS;YAcT,eAAe;CAoC9B"}
+{"version":3,"file":"shacl-validator.d.ts","sourceRoot":"","sources":["../src/shacl-validator.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAkB,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAezE,0CAA0C;AAC1C,MAAM,WAAW,qBAAqB;IACpC,6FAA6F;IAC7F,UAAU,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC;AAQD;;;;;;GAMG;AACH,qBAAa,cAAe,YAAW,SAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IAEnD,OAAO,CAAC,aAAa,CAAkB;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyC;gBAE1D,OAAO,EAAE,qBAAqB;IAMpC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAmCpE,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;YAc3C,SAAS;YAUT,eAAe;CA0B9B"}

package/dist/shacl-validator.js

@@ -1,12 +1,18 @@
 import { mkdir, appendFile, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
-import { Writer } from 'n3';
+import { serializeQuads } from '@lde/pipeline';
 // @ts-expect-error -- shacl-engine has no type declarations.
 import ShaclEngine from 'shacl-engine/Validator.js';
 // @ts-expect-error -- rdf-ext has no type declarations.
 import rdf from 'rdf-ext';
 import { rdfDereferencer } from 'rdf-dereference';
 import filenamifyUrl from 'filenamify-url';
+/** File extension per serialization format. */
+const formatExtensions = {
+    Turtle: '.ttl',
+    'N-Triples': '.nt',
+    'N-Quads': '.nq',
+};
 /**
  * SHACL-based {@link Validator} for `@lde/pipeline`.
  *
@@ -17,12 +23,14 @@ import filenamifyUrl from 'filenamify-url';
 export class ShaclValidator {
     shapesFile;
     reportDir;
+    reportFormat;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     shapesDataset;
     accumulators = new Map();
     constructor(options) {
         this.shapesFile = options.shapesFile;
         this.reportDir = options.reportDir;
+        this.reportFormat = options.reportFormat ?? 'Turtle';
     }
     async validate(quads, dataset) {
         if (quads.length === 0) {
@@ -67,16 +75,12 @@ export class ShaclValidator {
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     async getShapes() {
-        if (this.shapesDataset)
-            return this.shapesDataset;
-        const { data } = await rdfDereferencer.dereference(this.shapesFile, {
-            localFiles: true,
-        });
-        const dataset = rdf.dataset();
-        for await (const quad of data) {
-            dataset.add(quad);
+        if (!this.shapesDataset) {
+            const { data } = await rdfDereferencer.dereference(this.shapesFile, {
+                localFiles: true,
+            });
+            this.shapesDataset = await rdf.dataset().import(data);
         }
-        this.shapesDataset = dataset;
         return this.shapesDataset;
     }
     async writeReportFile(dataset, 
@@ -84,31 +88,16 @@ export class ShaclValidator {
     report) {
         await mkdir(this.reportDir, { recursive: true });
         const datasetName = filenamifyUrl(dataset.iri.toString());
-        const filePath = join(this.reportDir, `${datasetName}.validation.ttl`);
-        // Serialize the SHACL report dataset to Turtle.
+        const extension = formatExtensions[this.reportFormat];
+        const filePath = join(this.reportDir, `${datasetName}.validation${extension}`);
         const reportQuads = [...report.dataset];
-        const turtle = await new Promise((resolve, reject) => {
-            const writer = new Writer({
-                prefixes: {
-                    sh: 'http://www.w3.org/ns/shacl#',
-                },
-            });
-            for (const quad of reportQuads) {
-                writer.addQuad(quad);
-            }
-            writer.end((error, result) => {
-                if (error)
-                    reject(error);
-                else
-                    resolve(result);
-            });
-        });
-        // Check if file exists; if so, append. Otherwise, create.
+        const serialized = await serializeQuads(reportQuads, this.reportFormat);
+        // Append to existing file or create a new one.
         try {
-            await appendFile(filePath, '\n' + turtle);
+            await appendFile(filePath, '\n' + serialized);
         }
         catch {
-            await writeFile(filePath, turtle);
+            await writeFile(filePath, serialized);
         }
         return filePath;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lde/pipeline-shacl-validator",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "SHACL validation for @lde/pipeline",
   "repository": {
     "url": "git+https://github.com/ldelements/lde.git",
@@ -32,10 +32,10 @@
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "n3": "^2.0.1"
+    "n3": "^2.0.3"
   },
   "peerDependencies": {
     "@lde/dataset": "0.7.1",
-    "@lde/pipeline": "0.20.0"
+    "@lde/pipeline": "0.22.0"
   }
 }