fix: add hook for typeExpansion, cover @base null

Author: tplooker

lib/context.js

@@ -1041,6 +1041,14 @@ function _expandIri(activeCtx, value, relativeTo, localCtx, defined, options) {
     }
   }
 
+  // A flag that captures whether the iri being expanded is
+  // the value for an @type
+  let typeExpansion = false;
+
+  if (options !== undefined && options.typeExpansion !== undefined) {
+    typeExpansion = options.typeExpansion;
+  }
+
   if(relativeTo.vocab && '@vocab' in activeCtx) {
     // prepend vocab
     const prependedResult = activeCtx['@vocab'] + value;
@@ -1056,7 +1064,8 @@ function _expandIri(activeCtx, value, relativeTo, localCtx, defined, options) {
           type: '@vocab',
           vocab: activeCtx['@vocab'],
           value,
-          result: prependedResult
+          result: prependedResult,
+          typeExpansion,
         },
         activeCtx,
         options
@@ -1078,6 +1087,9 @@ function _expandIri(activeCtx, value, relativeTo, localCtx, defined, options) {
       if(activeCtx['@base']) {
         base = prependBase(options.base, activeCtx['@base']);
         prependedResult = prependBase(base, value);
+      } else {
+        base = activeCtx['@base'];
+        prependedResult = value;
       }
     } else {
       base = options.base;
@@ -1094,15 +1106,16 @@ function _expandIri(activeCtx, value, relativeTo, localCtx, defined, options) {
           type: '@base',
           base,
           value,
-          result: prependedResult
+          result: prependedResult,
+          typeExpansion,
         },
         activeCtx,
         options
       });
     }
     if(expansionMapResult !== undefined) {
       value = expansionMapResult;
-    } else if(prependedResult !== undefined) {
+    } else {
       // the null case preserves value as potentially relative
       value = prependedResult;
     }
@@ -1118,6 +1131,7 @@ function _expandIri(activeCtx, value, relativeTo, localCtx, defined, options) {
     const expandedResult = options.expansionMap({
       relativeIri: value,
       activeCtx,
+      typeExpansion,
       options
     });
     if(expandedResult !== undefined) {

lib/expand.js

@@ -431,7 +431,7 @@ async function _expandObject({
   const isJsonType = element[typeKey] &&
     _expandIri(activeCtx,
       (_isArray(element[typeKey]) ? element[typeKey][0] : element[typeKey]),
-      {vocab: true}, options) === '@json';
+      {vocab: true}, { ...options, typeExpansion: true }) === '@json';
 
   for(const key of keys) {
     let value = element[key];
@@ -527,7 +527,7 @@ async function _expandObject({
         value = Object.fromEntries(Object.entries(value).map(([k, v]) => [
           _expandIri(typeScopedContext, k, {vocab: true}),
           _asArray(v).map(vv =>
-            _expandIri(typeScopedContext, vv, {base: true, vocab: true})
+            _expandIri(typeScopedContext, vv, {base: true, vocab: true}, { ...options, typeExpansion: true })
           )
         ]));
       }
@@ -537,7 +537,7 @@ async function _expandObject({
         _asArray(value).map(v =>
           _isString(v) ?
             _expandIri(typeScopedContext, v,
-              {base: true, vocab: true}, options) : v),
+              {base: true, vocab: true}, { ...options, typeExpansion: true }) : v),
         {propertyIsArray: options.isFrame});
       continue;
     }
@@ -937,7 +937,7 @@ function _expandValue({activeCtx, activeProperty, value, options}) {
   if(expandedProperty === '@id') {
     return _expandIri(activeCtx, value, {base: true}, options);
   } else if(expandedProperty === '@type') {
-    return _expandIri(activeCtx, value, {vocab: true, base: true}, options);
+    return _expandIri(activeCtx, value, {vocab: true, base: true}, { ...options, typeExpansion: true });
   }
 
   // get type definition from context

tests/misc.js

@@ -614,6 +614,36 @@ describe('expansionMap', () => {
       assert.equal(expansionMapCalled, true);
     });
 
+    it('should be called on relative iri for type term in scoped context', async () => {
+      const docWithRelativeIriId = {
+        '@context': {
+          'definedType': {
+            '@id': 'https://example.com#definedType',
+            '@context': {
+              'definedTerm': 'https://example.com#definedTerm'
+
+            }
+          }
+        },
+        'id': "urn:absoluteiri",
+        '@type': "definedType",
+        definedTerm: {
+          '@type': 'relativeiri'
+        }
+      };
+
+      let expansionMapCalled = false;
+      const expansionMap = info => {
+        if(info.relativeIri === '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 = {
@@ -638,6 +668,38 @@ describe('expansionMap', () => {
       assert.equal(expansionMapCalledTimes, 3);
     });
 
+    it('should be called on relative iri for \
+    type term with multiple relative iri types in scoped context', async () => {
+      const docWithRelativeIriId = {
+        '@context': {
+          'definedType': {
+            '@id': 'https://example.com#definedType',
+            '@context': {
+              'definedTerm': 'https://example.com#definedTerm'
+
+            }
+          }
+        },
+        'id': "urn:absoluteiri",
+        '@type': "definedType",
+        definedTerm: {
+          '@type': ["relativeiri", "anotherRelativeiri" ]
+        }
+      };
+
+      let expansionMapCalledTimes = 0;
+      const expansionMap = info => {
+        if(info.relativeIri === 'relativeiri' ||
+           info.relativeIri === 'anotherRelativeiri') {
+          expansionMapCalledTimes++;
+        }
+      };
+
+      await jsonld.expand(docWithRelativeIriId, {expansionMap});
+
+      assert.equal(expansionMapCalledTimes, 3);
+    });
+
     it('should be called on relative iri for \
     type term with multiple types', async () => {
       const docWithRelativeIriId = {
@@ -764,6 +826,7 @@ describe('expansionMap', () => {
           type: '@vocab',
           vocab: 'http://example.com/',
           value: 'term',
+          typeExpansion: false,
           result: 'http://example.com/term'
         });
         expansionMapCalled = true;
@@ -789,6 +852,7 @@ describe('expansionMap', () => {
           type: '@vocab',
           vocab: 'http://example.com/',
           value: 'relativeIri',
+          typeExpansion: true,
           result: 'http://example.com/relativeIri'
         });
         expansionMapCalled = true;
@@ -815,6 +879,7 @@ describe('expansionMap', () => {
           type: '@vocab',
           vocab: 'http://example.com/',
           value: 'relativeIri',
+          typeExpansion: true,
           result: 'http://example.com/relativeIri'
         });
         expansionMapCalled = true;
@@ -841,6 +906,7 @@ describe('expansionMap', () => {
             type: '@base',
             base: 'http://example.com/',
             value: 'relativeIri',
+            typeExpansion: false,
             result: 'http://example.com/relativeIri'
           });
           expansionMapCalled = true;
@@ -869,6 +935,7 @@ describe('expansionMap', () => {
             type: '@base',
             base: 'http://example.com/',
             value: 'relativeIri',
+            typeExpansion: false,
             result: 'http://example.com/relativeIri'
           });
           expansionMapCalled = true;
@@ -896,6 +963,7 @@ describe('expansionMap', () => {
             type: '@base',
             base: 'http://example.com/',
             value: 'relativeIri',
+            typeExpansion: true,
             result: 'http://example.com/relativeIri'
           });
           expansionMapCalled = true;
@@ -924,6 +992,7 @@ describe('expansionMap', () => {
             type: '@base',
             base: 'http://example.com/',
             value: 'relativeIri',
+            typeExpansion: true,
             result: 'http://example.com/relativeIri'
           });
           expansionMapCalled = true;