Adds support for @included in compaction, expansion and flattening.

Coded added for framing, but not enabled due to big backlog on framing in general.

Author: gkellogg

CHANGELOG.md

@@ -35,6 +35,9 @@
 
 ## 2.0.1 - 2019-12-10
 
+### Added
+- Added support for `@included` blocks
+
 ### Fixed
 - JSON literal value handling issues.
 

lib/compact.js

@@ -343,8 +343,10 @@ api.compact = async ({
         continue;
       }
 
-      // skip array processing for keywords that aren't @graph or @list
+      // skip array processing for keywords that aren't
+      // @graph, @list, or @included
       if(expandedProperty !== '@graph' && expandedProperty !== '@list' &&
+        expandedProperty !== '@included' &&
         _isKeyword(expandedProperty)) {
         // use keyword alias and add value as is
         const alias = api.compactIri({

lib/context.js

@@ -1230,6 +1230,7 @@ api.isKeyword = v => {
     case '@explicit':
     case '@graph':
     case '@id':
+    case '@included':
     case '@index':
     case '@json':
     case '@language':

lib/expand.js

@@ -16,7 +16,8 @@ const {
 const {
   isList: _isList,
   isValue: _isValue,
-  isGraph: _isGraph
+  isGraph: _isGraph,
+  isSubject: _isSubject
 } = require('./graphTypes');
 
 const {
@@ -251,8 +252,8 @@ api.expand = async ({
     expandedParent: rval,
     options,
     insideList,
-    typeScopedContext,
     typeKey,
+    typeScopedContext,
     expansionMap});
 
   // get property count on expanded output
@@ -392,6 +393,7 @@ api.expand = async ({
  * @param expandedParent the expanded result into which to add values.
  * @param options the expansion options.
  * @param insideList true if the element is a list, false if not.
+ * @param typeKey first key found expanding to @type.
  * @param typeScopedContext the context before reverting.
  * @param expansionMap(info) a function that can be used to custom map
  *          unmappable values (or to throw an error when they are detected);
@@ -406,8 +408,8 @@ async function _expandObject({
   expandedParent,
   options = {},
   insideList,
-  typeScopedContext,
   typeKey,
+  typeScopedContext,
   expansionMap
 }) {
   const keys = Object.keys(element).sort();
@@ -459,8 +461,9 @@ async function _expandObject({
           {code: 'invalid reverse property map', value});
       }
       if(expandedProperty in expandedParent &&
-        expandedProperty !== '@included' &&
-        expandedProperty !== '@type') {
+         expandedProperty !== '@included' &&
+         expandedProperty !== '@type')
+      {
         throw new JsonLdError(
           'Invalid JSON-LD syntax; colliding keywords detected.',
           'jsonld.SyntaxError',
@@ -519,6 +522,31 @@ async function _expandObject({
       continue;
     }
 
+    // Included blocks are treated as an array of separate object nodes sharing
+    // the same referencing active_property.
+    // For 1.0, it is skipped as are other unknown keywords
+    if(expandedProperty === '@included' && _processingMode(activeCtx, 1.1)) {
+      const includedResult = _asArray(await api.expand({
+        activeCtx,
+        activeProperty,
+        element: value,
+        options,
+        expansionMap
+      }));
+
+      // Expanded values must be node objects
+      if(!includedResult.every(v => _isSubject(v))) {
+        throw new JsonLdError(
+          'Invalid JSON-LD syntax; ' +
+          'values of @included must expand to node objects.',
+          'jsonld.SyntaxError', {code: 'invalid @included value', value});
+      }
+
+      _addValue(
+        expandedParent, '@included', includedResult, {propertyIsArray: true});
+      continue;
+    }
+
     // @graph must be an array or an object
     if(expandedProperty === '@graph' &&
       !(_isObject(value) || _isArray(value))) {
@@ -632,6 +660,11 @@ async function _expandObject({
       continue;
     }
 
+    // skip unknown keywords
+    //if(expandedProperty.startsWith('@')) {
+    //  continue;
+    //}
+
     // use potential scoped context for key
     let termCtx = activeCtx;
     const ctx = _getContextValue(activeCtx, key, '@context');
@@ -825,6 +858,7 @@ async function _expandObject({
         insideList,
         typeScopedContext,
         typeKey,
+        typeScopedContext,
         expansionMap});
     }
   }

lib/frame.js

@@ -167,6 +167,13 @@ api.frame = (state, subjects, frame, parent, property = null) => {
       }
     }
 
+    // if frame has @included, recurse over its sub-frame
+    if('@included' in frame) {
+      api.frame(
+        state,
+        subjects, frame['@included'], output, '@included');
+    }
+
     // iterate over subject properties
     for(const prop of Object.keys(subject).sort()) {
       // copy keywords to output

lib/nodeMap.js

@@ -145,6 +145,12 @@ api.createNodeMap = (input, graphs, graph, issuer, name, list) => {
       continue;
     }
 
+    // recurse into included
+    if(property === '@included') {
+      api.createNodeMap(input[property], graphs, graph, issuer);
+      continue;
+    }
+
     // copy non-@type keywords
     if(property !== '@type' && isKeyword(property)) {
       if(property === '@index' && property in subject &&

tests/test-common.js

@@ -33,12 +33,6 @@ const TEST_TYPES = {
       specVersion: ['json-ld-1.0'],
       // FIXME
       idRegex: [
-        // included
-        /compact-manifest.jsonld#tin01$/,
-        /compact-manifest.jsonld#tin02$/,
-        /compact-manifest.jsonld#tin03$/,
-        /compact-manifest.jsonld#tin04$/,
-        /compact-manifest.jsonld#tin05$/,
         // direction
         /compact-manifest.jsonld#tdi01$/,
         /compact-manifest.jsonld#tdi02$/,
@@ -105,16 +99,6 @@ const TEST_TYPES = {
         /remote-doc-manifest.jsonld#t0013$/, // HTML
         // colliding keywords
         /expand-manifest.jsonld#t0114$/,
-        // included
-        /expand-manifest.jsonld#tin01$/,
-        /expand-manifest.jsonld#tin02$/,
-        /expand-manifest.jsonld#tin03$/,
-        /expand-manifest.jsonld#tin04$/,
-        /expand-manifest.jsonld#tin05$/,
-        /expand-manifest.jsonld#tin06$/,
-        /expand-manifest.jsonld#tin07$/,
-        /expand-manifest.jsonld#tin08$/,
-        /expand-manifest.jsonld#tin09$/,
         // keywords
         /expand-manifest.jsonld#tpr30$/,
         /expand-manifest.jsonld#tpr31$/,
@@ -159,13 +143,6 @@ const TEST_TYPES = {
         /html-manifest.jsonld#tf002$/,
         /html-manifest.jsonld#tf003$/,
         /html-manifest.jsonld#tf004$/,
-        // included
-        /flatten-manifest.jsonld#tin01$/,
-        /flatten-manifest.jsonld#tin02$/,
-        /flatten-manifest.jsonld#tin03$/,
-        /flatten-manifest.jsonld#tin04$/,
-        /flatten-manifest.jsonld#tin05$/,
-        /flatten-manifest.jsonld#tin06$/,
       ]
     },
     fn: 'flatten',
@@ -331,13 +308,6 @@ const TEST_TYPES = {
         /toRdf-manifest.jsonld#te112$/,
         // colliding keyword
         /toRdf-manifest.jsonld#te114$/,
-        // included
-        /toRdf-manifest.jsonld#tin01$/,
-        /toRdf-manifest.jsonld#tin02$/,
-        /toRdf-manifest.jsonld#tin03$/,
-        /toRdf-manifest.jsonld#tin04$/,
-        /toRdf-manifest.jsonld#tin05$/,
-        /toRdf-manifest.jsonld#tin06$/,
         // keywords
         /toRdf-manifest.jsonld#tpr30$/,
         /toRdf-manifest.jsonld#tpr31$/,