Support JSON param ranges via rdf:JSON, Closes #37

Read more about this feature at https://componentsjs.readthedocs.io/en/latest/configuration/components/parameters/#example-json-parameter
LinkedSoftwareDependencies · Jun 14, 2021 · 08b7950 · 08b7950
1 parent 2c0c1a6
commit 08b7950
Show file tree

Hide file tree

Showing 6 changed files with 1,423 additions and 1,578 deletions.
diff --git a/lib/preprocess/parameterproperty/ParameterPropertyHandlerRange.ts b/lib/preprocess/parameterproperty/ParameterPropertyHandlerRange.ts
@@ -1,5 +1,5 @@
 import type { RdfObjectLoader, Resource } from 'rdf-object';
-import { IRIS_XSD } from '../../rdf/Iris';
+import { IRIS_RDF, IRIS_XSD } from '../../rdf/Iris';
 import { ErrorResourcesContext } from '../../util/ErrorResourcesContext';
 import type { IParameterPropertyHandler } from './IParameterPropertyHandler';
 
@@ -71,6 +71,14 @@ export class ParameterPropertyHandlerRange implements IParameterPropertyHandler
             (<any>value.term).valueRaw = parsed;
           }
           break;
+        case IRIS_RDF.JSON:
+          try {
+            parsed = JSON.parse(value.value);
+            (<any>value.term).valueRaw = parsed;
+          } catch {
+            this.throwIncorrectTypeError(value, param);
+          }
+          break;
       }
     }
     return value;

diff --git a/lib/rdf/Iris.ts b/lib/rdf/Iris.ts
@@ -18,6 +18,7 @@ export const IRIS_RDF = {
   subject: PREFIX_RDF('subject'),
   object: PREFIX_RDF('object'),
   type: PREFIX_RDF('type'),
+  JSON: PREFIX_RDF('JSON'),
 };
 
 export const PREFIX_RDFS = definePrefix('http://www.w3.org/2000/01/rdf-schema#');

diff --git a/lib/rdf/RdfParser.ts b/lib/rdf/RdfParser.ts
@@ -1,11 +1,11 @@
+import { createReadStream } from 'fs';
 import type { Readable } from 'stream';
 import type * as RDF from 'rdf-js';
 import type { ParseOptions } from 'rdf-parse';
 import rdfParser from 'rdf-parse';
 import type { Logger } from 'winston';
 import { PrefetchedDocumentLoader } from './PrefetchedDocumentLoader';
 import { RdfStreamIncluder } from './RdfStreamIncluder';
-import { createReadStream } from 'fs';
 // Import syntax only works in Node > 12
 const fs = require('fs').promises;
 

diff --git a/package.json b/package.json
@@ -41,7 +41,7 @@
     "minimist": "^1.2.0",
     "rdf-data-factory": "^1.0.4",
     "rdf-object": "^1.8.0",
-    "rdf-parse": "^1.8.0",
+    "rdf-parse": "^1.8.1",
     "rdf-quad": "^1.5.0",
     "rdf-terms": "^1.6.2",
     "semver": "^7.3.2",
@@ -53,7 +53,7 @@
     "@typescript-eslint/parser": "^4.6.1",
     "@types/jest": "^26.0.23",
     "eslint": "^7.12.1",
-    "eslint-config-es": "^3.25.3",
+    "eslint-config-es": "3.25.3",
     "eslint-import-resolver-typescript": "^2.3.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^24.1.0",

diff --git a/test/unit/preprocess/parameterproperty/ParameterPropertyHandlerRange-test.ts b/test/unit/preprocess/parameterproperty/ParameterPropertyHandlerRange-test.ts
@@ -5,7 +5,7 @@ import 'jest-rdf';
 import {
   ParameterPropertyHandlerRange,
 } from '../../../../lib/preprocess/parameterproperty/ParameterPropertyHandlerRange';
-import { IRIS_XSD } from '../../../../lib/rdf/Iris';
+import { IRIS_RDF, IRIS_XSD } from '../../../../lib/rdf/Iris';
 
 const DF = new DataFactory();
 
@@ -137,5 +137,19 @@ describe('ParameterPropertyHandlerRange', () => {
         objectLoader.createCompactedResource({ range: IRIS_XSD.double }))).term.valueRaw)
         .toEqual(256.36);
     });
+
+    it('should capture JSON', () => {
+      expect((<any> handler.captureType(objectLoader.createCompactedResource('"1"'),
+        objectLoader.createCompactedResource({ range: IRIS_RDF.JSON }))).term.valueRaw)
+        .toEqual(1);
+      expect((<any> handler.captureType(objectLoader.createCompactedResource('"{"a":"b"}"'),
+        objectLoader.createCompactedResource({ range: IRIS_RDF.JSON }))).term.valueRaw)
+        .toEqual({ a: 'b' });
+    });
+    it('should error on invalid JSON', () => {
+      expect(() => handler.captureType(objectLoader.createCompactedResource('"{a:\\"b\\"}"'),
+        objectLoader.createCompactedResource({ range: IRIS_RDF.JSON, '@id': 'param' })))
+        .toThrowError(/^Parameter value .* is not of required range type/u);
+    });
   });
 });