feat: extend expansion map for detecting relative IRIs for @id and @type terms

Author: tplooker

lib/expand.js

@@ -505,10 +505,27 @@ async function _expandObject({
         }
       }
 
+      const expandedValues = _asArray(value).map(v =>
+        _isString(v) ? _expandIri(activeCtx, v, {base: true}, options) : v);
+
+      for(const i in expandedValues) {
+        if(_isString(expandedValues[i]) && !_isAbsoluteIri(expandedValues[i])) {
+          const expansionMapResult = await expansionMap({
+            relativeIri: {type: key, value: expandedValues[i]},
+            activeCtx,
+            activeProperty,
+            options,
+            insideList
+          });
+          if(expansionMapResult !== undefined) {
+            expandedValues[i] = expansionMapResult;
+          }
+        }
+      }
+
       _addValue(
         expandedParent, '@id',
-        _asArray(value).map(v =>
-          _isString(v) ? _expandIri(activeCtx, v, {base: true}, options) : v),
+        expandedValues,
         {propertyIsArray: options.isFrame});
       continue;
     }
@@ -525,12 +542,30 @@ async function _expandObject({
         ]));
       }
       _validateTypeValue(value, options.isFrame);
+
+      const expandedValues = _asArray(value).map(v =>
+        _isString(v) ?
+          _expandIri(typeScopedContext, v,
+            {base: true, vocab: true}, options) : v);
+
+      for(const i in expandedValues) {
+        if(_isString(expandedValues[i]) && !_isAbsoluteIri(expandedValues[i])) {
+          const expansionMapResult = await expansionMap({
+            relativeIri: {type: key, value: expandedValues[i]},
+            activeCtx,
+            activeProperty,
+            options,
+            insideList
+          });
+          if(expansionMapResult !== undefined) {
+            expandedValues[i] = expansionMapResult;
+          }
+        }
+      }
+
       _addValue(
         expandedParent, '@type',
-        _asArray(value).map(v =>
-          _isString(v) ?
-            _expandIri(typeScopedContext, v,
-              {base: true, vocab: true}, options) : v),
+        expandedValues,
         {propertyIsArray: options.isFrame});
       continue;
     }

tests/misc.js

@@ -478,3 +478,207 @@ describe('literal JSON', () => {
     });
   });
 });
+
+describe('expansionMap', () => {
+  it('should be called on un-mapped term', async () => {
+    const docWithUnMappedTerm = {
+      '@context': {
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      definedTerm: "is defined",
+      testUndefined: "is undefined"
+    };
+
+    let expansionMapCalled = false;
+    const expansionMap = info => {
+      if(info.unmappedProperty === 'testUndefined') {
+        expansionMapCalled = true;
+      }
+    };
+
+    await jsonld.expand(docWithUnMappedTerm, {expansionMap});
+
+    assert.equal(expansionMapCalled, true);
+  });
+
+  it('should be called on nested un-mapped term', async () => {
+    const docWithUnMappedTerm = {
+      '@context': {
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      definedTerm: {
+        testUndefined: "is undefined"
+      }
+    };
+
+    let expansionMapCalled = false;
+    const expansionMap = info => {
+      if(info.unmappedProperty === 'testUndefined') {
+        expansionMapCalled = true;
+      }
+    };
+
+    await jsonld.expand(docWithUnMappedTerm, {expansionMap});
+
+    assert.equal(expansionMapCalled, true);
+  });
+
+  it('should be called on relative iri for id term', async () => {
+    const docWithRelativeIriId = {
+      '@context': {
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      '@id': "relativeiri",
+      definedTerm: "is defined"
+    };
+
+    let expansionMapCalled = false;
+    const expansionMap = info => {
+      if(info.relativeIri && info.relativeIri.value === 'relativeiri') {
+        expansionMapCalled = true;
+      }
+    };
+
+    await jsonld.expand(docWithRelativeIriId, {expansionMap});
+
+    assert.equal(expansionMapCalled, true);
+  });
+
+  it('should be called on relative iri for id term (nested)', async () => {
+    const docWithRelativeIriId = {
+      '@context': {
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      '@id': "urn:absoluteIri",
+      definedTerm: {
+        '@id': "relativeiri"
+      }
+    };
+
+    let expansionMapCalled = false;
+    const expansionMap = info => {
+      if(info.relativeIri && info.relativeIri.value === 'relativeiri') {
+        expansionMapCalled = true;
+      }
+    };
+
+    await jsonld.expand(docWithRelativeIriId, {expansionMap});
+
+    assert.equal(expansionMapCalled, true);
+  });
+
+  it('should be called on relative iri for aliased id term', async () => {
+    const docWithRelativeIriId = {
+      '@context': {
+        'id': '@id',
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      'id': "relativeiri",
+      definedTerm: "is defined"
+    };
+
+    let expansionMapCalled = false;
+    const expansionMap = info => {
+      if(info.relativeIri && info.relativeIri.value === 'relativeiri') {
+        expansionMapCalled = true;
+      }
+    };
+
+    await jsonld.expand(docWithRelativeIriId, {expansionMap});
+
+    assert.equal(expansionMapCalled, true);
+  });
+
+  it('should be called on relative iri for type term', async () => {
+    const docWithRelativeIriId = {
+      '@context': {
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      'id': "urn:absoluteiri",
+      '@type': "relativeiri",
+      definedTerm: "is defined"
+    };
+
+    let expansionMapCalled = false;
+    const expansionMap = info => {
+      if(info.relativeIri && info.relativeIri.value === 'relativeiri') {
+        expansionMapCalled = true;
+      }
+    };
+
+    await jsonld.expand(docWithRelativeIriId, {expansionMap});
+
+    assert.equal(expansionMapCalled, true);
+  });
+
+  it('should be called on relative iri for \
+  type term with multiple relative iri types', async () => {
+    const docWithRelativeIriId = {
+      '@context': {
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      'id': "urn:absoluteiri",
+      '@type': ["relativeiri", "anotherRelativeiri" ],
+      definedTerm: "is defined"
+    };
+
+    let expansionMapCalledTimes = 0;
+    const expansionMap = info => {
+      if(info.relativeIri &&
+        (info.relativeIri.value === 'relativeiri' ||
+         info.relativeIri.value === 'anotherRelativeiri')) {
+        expansionMapCalledTimes++;
+      }
+    };
+
+    await jsonld.expand(docWithRelativeIriId, {expansionMap});
+
+    assert.equal(expansionMapCalledTimes, 2);
+  });
+
+  it('should be called on relative iri for \
+  type term with multiple types', async () => {
+    const docWithRelativeIriId = {
+      '@context': {
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      'id': "urn:absoluteiri",
+      '@type': ["relativeiri", "definedTerm" ],
+      definedTerm: "is defined"
+    };
+
+    let expansionMapCalled = false;
+    const expansionMap = info => {
+      if(info.relativeIri && info.relativeIri.value === 'relativeiri') {
+        expansionMapCalled = true;
+      }
+    };
+
+    await jsonld.expand(docWithRelativeIriId, {expansionMap});
+
+    assert.equal(expansionMapCalled, true);
+  });
+
+  it('should be called on relative iri for aliased type term', async () => {
+    const docWithRelativeIriId = {
+      '@context': {
+        'type': "@type",
+        'definedTerm': 'https://example.com#definedTerm'
+      },
+      'id': "urn:absoluteiri",
+      'type': "relativeiri",
+      definedTerm: "is defined"
+    };
+
+    let expansionMapCalled = false;
+    const expansionMap = info => {
+      if(info.relativeIri && info.relativeIri.value === 'relativeiri') {
+        expansionMapCalled = true;
+      }
+    };
+
+    await jsonld.expand(docWithRelativeIriId, {expansionMap});
+
+    assert.equal(expansionMapCalled, true);
+  });
+});