JSON-LD 1.0 Processing Algorithms and API

Algorithm

This algorithm specifies how a new active context is updated with a local context . The algorithm takes three input variables: an active context , a local context , and an array remote contexts which is used to detect cyclical context inclusions. If remote contexts is not passed, it is initialized to an empty array .

1. Initialize result to the result of cloning active context .
2. If local context is not an array , set it to an array containing only local context .
3. For each item context in local context :
   1. If context is null , set result to a newly-initialized active context and continue with the next context . The base IRI of the active context is set to the IRI of the currently being processed document (which might be different from the currently being processed context), if available; otherwise to null . If set, the compactArrays option of a JSON-LD API Implementation overrides the base IRI .
   2. If context is a string ,
      1. Set context to the result of resolving value against the base IRI which is established as specified in section 5.1 Establishing a Base URI of [ RFC3986 ]. Only the basic algorithm in section 5.2 of [ RFC3986 ] is used; neither Syntax-Based Normalization nor Scheme-Based Normalization are performed. Characters additionally allowed in IRI references are treated in the same way that unreserved characters are treated in URI references, per section 6.5 of [ RFC3987 ].
      2. If context is in the remote contexts array, a recursive context inclusion error has been detected and processing is aborted; otherwise, add context to remote contexts .
      3. Initialize context no base to the result of cloning the active context . Remove the base IRI of Dereference context no base . Dereference If context . cannot be dereferenced, a loading remote context failed error has been detected and processing is aborted. If the dereferenced document has no top-level JSON object with an @context member, an invalid remote context has been detected and processing is aborted; otherwise, set context to the value of that member.
      4. Set context result to the result of recursively calling this algorithm, passing context no base result for active context , context for local context , and remote contexts .
      5. If context has no base IRI but result does, set the base IRI of context to the one of result . Overwrite result with context and continue Continue with the next context .
   3. If context is not a JSON object , an invalid local context error has been detected and processing is aborted.
   4. If context has an @base key: Feature at Risk 1 : @base keyword Note: This feature is "at risk" key and may be removed from this specification based on feedback. Please send feedback to public-rdf-comments@w3.org . For the current status see features "at risk" in JSON-LD 1.0 Support for the @base keyword might be removed from JSON-LD 1.0 if implementation experience reveals that the fact that a document may have multiple base IRIs is confusing for developers. It remote contexts is also being discussed whether relative IRIs are allowed as values of @base or whether empty, i.e., the empty string should be used to explicitly specify that there isn't currently being processed context is not a base IRI , which could be used to ensure that relative IRIs remain relative when expanding. remote context:
      1. Initialize value to the value associated with the @base key.
      2. If value is null , remove the base IRI of result .
      3. Otherwise, if value is an absolute IRI , the base IRI of result is set to value . If it
      4. Otherwise, if value is not an absolute a relative IRI and the base IRI of result is not null , set the base IRI of result to the result of resolving value against the current base IRI of result .
      5. Otherwise, an invalid base IRI error has been detected and processing is aborted.
   5. If context has an @vocab key:
      1. Initialize value to the value associated with the @vocab key.
      2. If value is null , remove any vocabulary mapping from result .
      3. Otherwise, if value is an absolute IRI , the vocabulary mapping of result is set to value . If it is not an absolute IRI , an invalid vocab mapping error has been detected and processing is aborted.
   6. If context has an @language key:
      1. Initialize value to the value associated with the @language key.
      2. If value is null , remove any default language from result .
      3. Otherwise, if value is string , the default language of result is set to lowercased value . If it is not a string , an invalid default language error has been detected and processing is aborted.
   7. Create a JSON object defined to use to keep track of whether or not a term has already been defined or currently being defined during recursion.
   8. For each key - value pair in context where key is not @base , @vocab , or @language , invoke the Create Term Definition algorithm , passing result for active context , context for local context , key , and defined .
4. Return result .

Algorithm

The algorithm has four required inputs which are: an active context , a local context , a term , and a map defined .

1. If defined contains the key term and the associated value is true (indicating that the term definition has already been created), return. Otherwise, if the value is false , a cyclic IRI mapping error has been detected and processing is aborted.
2. Set the value associated with defined 's term key to false . This indicates that the term definition is now being created but is not yet complete.
3. Since keywords cannot be overridden, term must not be a keyword . Otherwise, a keyword redefinition error has been detected and processing is aborted.
4. Remove any existing term definition for term in active context .
5. Initialize value to a copy of the value associated with the key term in local context .
6. If value is null or value is a JSON object containing the key-value pair @id - null , set the term definition in active context to null , set the value associated with defined 's key term to true , and return.
7. Otherwise, if value is a string : Expand value by setting , convert it to the result of using the IRI Expansion algorithm , passing active context , value , true for vocab , true a JSON object for document relative , local context , and defined . If value consisting of a single member whose key is @context , an invalid keyword alias @id error has been detected and processing whose value is aborted. Set the IRI mapping for the term definition for term in active context to value , set the value associated with defined 's key term to true , and return. .
8. Otherwise, value must be a JSON object , if not, an invalid term definition error has been detected and processing is aborted.
9. Create a new term definition , definition .
10. If value contains the key @reverse :
    1. If value contains an @id , an @type , or an @language , member, an invalid reverse property error has been detected and processing is aborted.
    2. If the value associated with the @reverse key is not a string , an invalid IRI mapping error has been detected and processing is aborted.
    3. Otherwise, set the IRI mapping of definition to the result of using the IRI Expansion algorithm , passing active context , the value associated with the @reverse key for value , true for vocab , true false for document relative , local context , and defined . If the result is not an absolute IRI , i.e., it contains no colon ( : ), an invalid IRI mapping error has been detected and processing is aborted.
    4. Set the type mapping of definition to @id .
    5. If value contains an @container member, set the container mapping of definition to @index if that is the value of the @container member; otherwise an invalid reverse property error has been detected (reverse properties only support index-containers) and processing is aborted.
    6. Set the reverse property flag of definition to true .
    7. Set the term definition of term in active context to definition and the value associated with defined 's key term to true and return.
11. Set the reverse property flag of definition to false .
12. If value contains the key @id : and its value does not equal term :
    1. If the value associated with the @id key is not a string , an invalid IRI mapping error has been detected and processing is aborted.
    2. Otherwise, set the IRI mapping of definition to the result of using the IRI Expansion algorithm , passing active context , the value associated with the @id key for value , true for vocab , true false for document relative , local context , and defined . If the resulting IRI mapping equals @context , an invalid keyword alias error has been detected and processing is aborted.
13. Otherwise if the term contains a colon ( : ):
    1. If term is a compact IRI with a prefix that is a key in local context a dependency has been found. Use this algorithm recursively passing active context , local context , the prefix as term , and defined .
    2. If term 's prefix has a term definition in active context , set the IRI mapping of definition to the result of concatenating the value associated with the prefix 's IRI mapping and the term 's suffix .
    3. Otherwise, term is an absolute IRI . Set the IRI mapping of definition to term .
14. Otherwise, if active context has a vocabulary mapping , the IRI mapping of definition is set to the result of concatenating the value associated with the vocabulary mapping and term . If it does not have a vocabulary mapping , an invalid IRI mapping error been detected and processing is aborted.
15. If value contains the key @type :
    1. Initialize type to the value associated with the @type key, which must be a string . Otherwise, an invalid type mapping error has been detected and processing is aborted.
    2. Set type to the result of using the IRI Expansion algorithm , passing active context , type for value , true for vocab , true false for document relative , local context , and defined . If the expanded type is neither @id , nor @vocab , nor an absolute IRI , an invalid type mapping error has been detected and processing is aborted.
    3. Set the type mapping for definition to type .
16. If value contains the key @container :
    1. Initialize container to the value associated with the @container key, which must be either @list , @set , @index , or @language . Otherwise, an invalid container mapping error has been detected and processing is aborted.
    2. Set the container mapping of definition to container .
17. If value contains the key @language and does not contain the key @type :
    1. Initialize language to the value associated with the @language key, which must be either null or a string . Otherwise, an invalid language mapping error has been detected and processing is aborted.
    2. If language is a string set it to lowercased language . Set the language mapping of definition to language .
18. Set the term definition of term in active context to definition and set the value associated with defined 's key term to true .

Algorithm

The algorithm takes two required and four optional input variables. The required inputs are an active context and a value to be expanded. The optional inputs are two flags, document relative and vocab , that specifying whether value can be interpreted as a relative IRI against the document's base IRI or the active context's vocabulary mapping , respectively, and a local context and a map defined to be used when this algorithm is used during Context Processing . If not passed, the two flags are set to false and local context and defined are initialized to null .

1. If value is a keyword or null , return value as is.
2. If local context is not null , it contains a key that equals value , and the value associated with the key that equals value in defined is not true , invoke the Create Term Definition algorithm , passing active context , local context , value as term , and defined . This will ensure that a term definition is created for value in active context during Context Processing .
3. If vocab is true and the active context has a term definition for value , return the associated IRI mapping .
4. If value contains a colon ( : ), it is either an absolute IRI or a compact IRI :
   1. Split value into a prefix and suffix at the first occurrence of a colon ( : ).
   2. If prefix is underscore ( _ ) or suffix begins with double-forward-slash ( // ), return value as it is already an absolute IRI or a blank node identifier .
   3. If local context is not null , it contains a key that equals prefix , and the value associated with the key that equals prefix in defined is not true , invoke the Create Term Definition algorithm , passing active context , local context , prefix as term , and defined . This will ensure that a term definition is created for prefix in active context during Context Processing .
   4. If active context contains a term definition for prefix , return the result of concatenating the IRI mapping associated with prefix and suffix .
   5. Return value as it is already an absolute IRI .
5. If vocab is true , and active context has a vocabulary mapping , return the result of concatenating the vocabulary mapping with value .
6. Otherwise, if document relative is true , set value to the result of resolving value against the base IRI . Only the basic algorithm in section 5.2 of [ RFC3986 ] is used; neither Syntax-Based Normalization nor Scheme-Based Normalization are performed. Characters additionally allowed in IRI references are treated in the same way that unreserved characters are treated in URI references, per section 6.5 of [ RFC3987 ].
7. If local context is not null and value is not an absolute IRI , an invalid IRI mapping error has been detected and processing is aborted.
8. Otherwise, return value as is.

Algorithm

The algorithm takes three input variables: an active context , an active property , and an element to be expanded. To begin, the active context is set to the result of performing, Context Processing on the passed expandContext , or empty if expandContext is null , active property is set to null , and element is set to the JSON-LD input .

1. If element is null , return null .
2. If element is a scalar ,
   1. If active property is null or @graph , drop the free-floating scalar by returning null .
   2. Return the result of the Value Expansion algorithm , passing the active context , active property , and element as value .
3. If element is an array ,
   1. Initialize an empty array, result .
   2. For each item in element :
      1. Initialize expanded item to the result of using this algorithm recursively, passing active context , active property , and item as element .
      2. If the active property is @list or its container mapping is set to @list , the expanded item must not be an array or a list object , otherwise a list of lists error has been detected and processing is aborted.
      3. If expanded item is an array , append each of its items to result . Otherwise, if expanded item is not null, append it to result .
   3. Return result .
4. Otherwise element is a JSON object .
5. If element contains the key @context , set active context to the result of the Context Processing algorithm , passing active context and the value of the @context key as local context .
6. Initialize an empty JSON object , result .
7. For each key and value in element , ordered lexicographically by key :
   1. If key is @context , continue to the next key .
   2. Set expanded property to the result of using the IRI Expansion algorithm , passing active context , key for value , and true for vocab .
   3. If expanded property is null or it neither contains a colon ( : ) nor it is a keyword , drop key by continuing to the next key .
   4. If expanded property is a keyword :
      1. If active property equals @reverse , an invalid reverse property map error has been detected and processing is aborted.
      2. If result has already an expanded property member, an colliding keywords error has been detected and processing is aborted.
      3. If expanded property is @id and value is not a string , an invalid @id value error has been detected and processing is aborted. Otherwise, set expanded value to the result of using the IRI Expansion algorithm , passing active context , value , and true for document relative .
      4. If expanded property is @type and value is neither a string nor an array of strings , an invalid type value error has been detected and processing is aborted. Otherwise, set expanded value to the result of using the IRI Expansion algorithm , passing active context , true for vocab , and true for document relative to expand the value or each of its items.
      5. If expanded property is @graph , set expanded value to the result of using this algorithm recursively passing active context , @graph for active property , and value for element .
      6. If expanded property is @value and value is not a scalar or null , an invalid value object value error has been detected and processing is aborted. Otherwise, set expanded value to value . If expanded value is null , set the @value member of result to null and continue with the next key from element . Null values need to be preserved in this case as the meaning of an @type member depends on the existence of an @value member.
      7. If expanded property is @language and value is not a string , an invalid language-tagged string error has been detected and processing is aborted. Otherwise, set expanded value to lowercased value .
      8. If expanded property is @index and value is not a string , an invalid @index value error has been detected and processing is aborted. Otherwise, set expanded value to value .
      9. If expanded property is @list :
         1. If active property is null or @graph , continue with the next key from element to remove the free-floating list.
         2. Otherwise, initialize expanded value to the result of using this algorithm recursively passing active context , active property , and value for element .
         3. If expanded value is a list object , a list of lists error has been detected and processing is aborted.
      10. If expanded property is @set , set expanded value to the result of using this algorithm recursively, passing active context , active property , and value for element .
      11. If expanded property is @reverse and value is not a JSON object , an invalid @reverse value error has been detected and processing is aborted. Otherwise
          1. Initialize expanded value to the result of using this algorithm recursively, passing active context , @reverse as active property , and value as element .
          2. If expanded value contains an @reverse member, i.e., properties that are reversed twice, execute for each of its property and item the following steps:
             1. If result does not have a property member, create one and set its value to an empty array .
             2. Append item to the value of the property member of result .
          3. If expanded value contains members other than @reverse :
             1. If result does not have an @reverse member, create one and set its value to an empty JSON object .
             2. Reference the value of the @reverse member in result using the variable reverse map .
             3. For each property and items in expanded value other than @reverse :
                1. For each item in items :
                   1. If item is a value object or list object , an invalid reverse property value has been detected and processing is aborted.
                   2. If reverse map has no property member, create one and initialize its value to an empty array .
                   3. Append item to the value of the property member in reverse map .
          4. Continue with the next key from element .
      12. Unless expanded value is null , set the expanded property member of result to expanded value .
      13. Continue with the next key from element. element .
   5. Otherwise, if key 's container mapping in active context is @language and value is a JSON object then value is expanded from a language map as follows:
      1. Initialize expanded value to an empty array .
      2. For each key-value pair language - language value in value , ordered lexicographically by language :
         1. If language value is not an array set it to an array containing only language value .
         2. For each item in language value :
            1. item must be a string , otherwise an invalid language map value error has been detected and processing is aborted.
            2. Append a JSON object to expanded value that consists of two key-value pairs: ( @value - item ) and ( @language -lowercased language ).
   6. Otherwise, if key 's container mapping in active context is @index and value is a JSON object then value is expanded from an index map as follows:
      1. Initialize expanded value to an empty array .
      2. For each key-value pair index - index value in value , ordered lexicographically by index :
         1. If index value is not an array set it to an array containing only index value .
         2. Initialize index value to the result of using this algorithm recursively, passing active context , key as active property , and index value as element .
         3. For each item in index value :
            1. If item does not have the key @index , add the key-value pair ( @index - index ) to item .
            2. Append item to expanded value .
   7. Otherwise, initialize expanded value to the result of using this algorithm recursively, passing active context , key for active property , and value for element .
   8. If expanded value is null , ignore key by continuing to the next key from element .
   9. If the container mapping associated to key in active context is @list and expanded value is not already a list object , convert expanded value to a list object by first setting it to an array containing only expanded value if it is not already an array , and then by setting it to a JSON object containing the key-value pair @list - expanded value .
   10. Otherwise, if the term definition associated to key indicates that it is a reverse property
       1. If result has no @reverse member, create one and initialize its value to an empty JSON object .
       2. Reference the value of the @reverse member in result using the variable reverse map .
       3. If expanded value is not an array , set it to an array containing expanded value .
       4. For each item in expanded value
          1. If item is a value object or list object , an invalid reverse property value has been detected and processing is aborted.
          2. If reverse map has no expanded property member, create one and initialize its value to an empty array .
          3. Append item to the value of the expanded property member of reverse map .
   11. Otherwise, if key is not a reverse property :
       1. If result does not have an expanded property member, create one and initialize its value to an empty array .
       2. Append expanded value to value of the expanded property member of result .
8. If result contains the key @value :
   1. The result must not contain any keys other than @value , @language , @type , and @index . It must not contain both the @language key and the @type key. Otherwise, an invalid value object error has been detected and processing is aborted.
   2. If the value of result 's @value key is null , then set result to null .
   3. Otherwise, if the value of result 's @value member is not a string and result contains the key @language , an invalid language-tagged value error has been detected (only strings can be language-tagged) and processing is aborted.
   4. Otherwise, if the result has a @type member and its value is not a string , an invalid typed value error has been detected and processing is aborted.
9. Otherwise, if result contains the key @type and its associated value is not an array , set it to an array containing only the associated value.
10. Otherwise, if result contains the key @set or @list :
    1. The result must contain at most one other key and that key must be @index . Otherwise, an invalid set or list object error has been detected and processing is aborted.
    2. If result contains the key @set , then set result to the key's associated value.
11. If result contains only the key @language , set result to null .
12. If active property is null or @graph , drop free-floating values as follows:
    1. If result is an empty JSON object or contains the keys @value or @list , set result to null .
    2. Otherwise, if result is a JSON object whose only key is @id , set result to null .
13. Return result .

If, after the above algorithm is run, the result is a JSON object that contains only an @graph key, set the result to the value of @graph 's value. Otherwise, if the result is null , set it to an empty array . Finally, if the result is not an array , then set the result to an array containing only the result.

Algorithm

The algorithm takes three required inputs: an active context , an active property , and a value to expand.

1. If the active property has a type mapping in active context that is @id , return a new JSON object containing a single key-value pair where the key is @id and the value is the result of using the IRI Expansion algorithm , passing active context , value , and true for document relative .
2. If active property has a type mapping in active context that is @vocab , return a new JSON object containing a single key-value pair where the key is @id and the value is the result of using the IRI Expansion algorithm , passing active context , value , true for vocab , and true for document relative .
3. Otherwise, initialize result to a JSON object with an @value member whose value is set to value .
4. If active property has a type mapping in active context , add an @type member to result and set its value to the value associated with the type mapping .
5. Otherwise, if value is a string :
   1. If a language mapping is associated with active property in active context , add an @language to result and set its value to the language code associated with the language mapping ; unless the language mapping is set to null in which case no member is added.
   2. Otherwise, if the active context has a default language , add an @language to result and set its value to the default language .
6. Return result .

Algorithm

The algorithm takes five required input variables: an active context , an inverse context , an active property , an element to be compacted, and a flag compactArrays . To begin, the active context is set to the result of performing Context Processing on the passed context , the inverse context is set to the result of performing the Inverse Context Creation algorithm on active context , the active property is set to null , element is set to the result of performing the Expansion algorithm on the JSON-LD input , and, if not passed, compactArrays is set to true .

1. If element is a scalar , it is already in its most compact form, so simply return element .
2. If element is an array :
   1. Initialize result to an empty array .
   2. For each item in element :
      1. Initialize compacted item to the result of using this algorithm recursively, passing active context , inverse context , active property , and em>item item for element .
      2. If compacted item is not null , then append it to result .
   3. If result contains only one item (it has a length of 1 ), active property has no container mapping in active context , and compactArrays is true , set result to its only item.
   4. Return result .
3. Otherwise element is a JSON object .
4. If element has an @value or @id member and the result of using the Value Compaction algorithm , passing active context , inverse context , active property ,and element as value is a scalar , return that result.
5. Initialize inside reverse to true if active property equals @reverse , otherwise to false .
6. Initialize result to an empty JSON object .
7. For each key expanded property and value expanded value in element , ordered lexicographically by expanded property :
   1. If expanded property is @id or @type :
      1. If expanded value is a string , then initialize compacted value to the result of using the IRI Compaction algorithm , passing active context , inverse context , expanded value for iri , and true for vocab if expanded property is @type , false otherwise.
      2. Otherwise, expanded value must be a @type array :
         1. Initialize compacted value to an empty array .
         2. For each item expanded type in expanded value , append the result of of using the IRI Compaction algorithm , passing active context , inverse context , expanded type for iri , and true for vocab , to compacted value .
         3. If compacted value contains only one item (it has a length of 1 ), then set compacted value to its only item.
      3. Initialize alias to the result of using the IRI Compaction algorithm , passing active context , inverse context , and expanded property for iri .
      4. Add a member alias to result whose value is set to compacted value and continue to the next expanded property .
   2. If expanded property is @reverse :
      1. Initialize compacted value to the result of using this algorithm recursively, passing active context , inverse context , @reverse for active property , and expanded value for element .
      2. For each property and value in compacted value :
         1. If the term definition for property in the active context indicates that property is a reverse property
            1. If compactArrays is false and value is not an array , set value to a new array containing only value .
            2. If property is not a member of result , add one and set its value to value .
            3. Otherwise, if the value of the property member of result is not an array , set it to a new array containing only the value. Then append value to its value if value is not an array , otherwise append each of its items.
            4. Remove the property member from compacted value .
      3. If compacted value has some remaining members, i.e., it is not an empty JSON object :
         1. Initialize alias to the result of using the IRI Compaction algorithm , passing active context , inverse context , and @reverse for iri .
         2. Set the value of the alias member of result to compacted value and continue with the next expanded property from element .
   3. If expanded property is @index and active property has a container mapping in active context that is @index , then the compacted result will be inside of an @index container, drop the @index property by continuing to the next expanded property .
   4. Otherwise, if expanded property is @index , @value , or @language :
      1. Initialize alias to the result of using the IRI Compaction algorithm , passing active context , inverse context , and expanded property for iri .
      2. Add a member alias to result whose value is set to expanded value and continue with the next expanded property .
   5. If expanded value is an empty array :
      1. Initialize item active property to the result of using the IRI Compaction algorithm , passing active context , inverse context , expanded property for iri , expanded value for value , true for vocab , and inside reverse .
      2. If result does not have the key that equals item active property , set this key's value in result to an empty array . Otherwise, if the key's value is not an array , then set it to one containing only the value.
   6. At this point, expanded value must be an array due to the Expansion algorithm . For each item expanded item in expanded value :
      1. Initialize item active property to the result of using the IRI Compaction algorithm , passing active context , inverse context , expanded property for iri , expanded item for value , true for vocab , and inside reverse .
      2. Initialize container to null . If there is a container mapping for item active property in active context , set container to its value.
      3. Initialize compacted item to the result of using this algorithm recursively, passing active context , inverse context , item active property for active property , expanded item for element if it does not contain the key @list , otherwise pass the key's associated value for element .
      4. If expanded item is a list object :
         1. If compacted item is not an array , then set it to an array containing only compacted item .
         2. If container is not @list :
            1. Convert compacted item to a list object by setting it to a JSON object containing key-value pair where the key is the result of the IRI Compaction algorithm , passing active context , inverse context , @list for iri , and compacted item for value .
            2. If expanded item contains the key @index , then add a key-value pair to compacted item where the key is the result of the IRI Compaction algorithm , passing active context , inverse context , @index as iri , and the value associated with the @index key in expanded item as value .
         3. Otherwise, item active property must not be a key in result because there cannot be two list objects associated with an active property that has a container mapping ; a compaction to list of lists error has been detected and processing is aborted.
      5. If container is @language or @index :
         1. If item active property is a key in result , then initialize map object to its associated value, otherwise initialize it to an empty JSON object .
         2. If container is @language and compacted item contains the key @value , then set compacted item to the value associated with its @value key.
         3. Initialize map key to the value associated with with the key that equals container in expanded item .
         4. If map key is not a key in map object , then set this key's value in map object to compacted item . Otherwise, if the value is not an array , then set it to one containing only the value and then append compacted item to it.
      6. Otherwise,
         1. If compactArrays is false , container is @set or @list , or expanded property is @list or @graph and compacted item is not an array , set it to a new array containing only compacted item .
         2. If item active property is not a key in result then add the key-value pair, ( item active property - compacted item ), to result .
         3. Otherwise, if the value associated with the key that equals item active property in result is not an array , set it to a new array containing only the value. Then append compacted item to the value if compacted item is not an array , otherwise, concatenate it.
8. Return result .

If, after the algorithm outlined above is run, the result result is an array , replace it with a new JSON object with a single member whose key is the result of using the IRI Compaction algorithm , passing active context , inverse context , and @graph as iri and whose value is the array result . Finally, if a non-empty context has been passed, add an @context member to result and set its value to the passed context .

Algorithm

The algorithm takes one required input: the active context that the inverse context is being created for.

1. Initialize result to an empty JSON object .
2. Initialize default language to @none . If the active context has a default language , set default language to it.
3. For each key term and value term definition in the active context , ordered by shortest term first (breaking ties by choosing the lexicographically least term ):
   1. If the term definition is null , term cannot be selected during compaction , so continue to the next term .
   2. Initialize container to @none . If there is a container mapping in term definition , set container to its associated value.
   3. Initialize iri to the value of the IRI mapping for the term definition .
   4. If iri is not a key in result , add a key-value pair where the key is iri and the value is an empty JSON object to result .
   5. Reference the value associated with the iri member in result using the variable container map .
   6. If container map has no container map member, create one and set its value to a new JSON object with two members. The first member is @language and its value is a new empty JSON object , the second member is @type and its value is a new empty JSON object .
   7. Reference the value associated with the container member in container map using the variable type/language map .
   8. If the term definition indicates that the term represents a reverse property :
      1. Reference the value associated with the @type member in type/language map using the variable type map .
      2. If type map does not have a @reverse member, create one and set its value to the term being processed.
   9. Otherwise, if term definition has a type mapping :
      1. Reference the value associated with the @type member in type/language map using the variable type map .
      2. If type map does not have a member corresponding to the type mapping in term definition , create one and set its value to the term being processed.
   10. Otherwise, if term definition has a language mapping (might be null ):
       1. Reference the value associated with the @language member in type/language map using the variable language map .
       2. If the language mapping equals null , set language to @null ; otherwise set it to the language code in language mapping .
       3. If language map does not have a language member, create one and set its value to the term being processed.
   11. Otherwise:
       1. Reference the value associated with the @language member in type/language map using the variable language map .
       2. If language map does not have a default language member, create one and set its value to the term being processed.
       3. If language map does not have a @none member, create one and set its value to the term being processed.
       4. Reference the value associated with the @type member in type/language map using the variable type map .
       5. If type map does not have a @none member, create one and set its value to the term being processed.
4. Return result .

Algorithm

This algorithm takes three required inputs and three optional inputs. The required inputs an active context , an inverse context , and the iri to be compacted. The optional inputs are a value associated with the iri , a vocab flag which specifies whether the passed iri should be compacted using the active context's vocabulary mapping , and a reverse flag which specifies whether a reverse property is being compacted. If not passed, value is set to null and vocab and reverse are both set to false .

1. If iri is null , return null .
2. If vocab is true and iri is a key in inverse context :
   1. Initialize default language to active context's default language , if it has one, otherwise to @none .
   2. Initialize containers to an empty array . This array will be used to keep track of an ordered list of preferred container mappings for a term , based on what is compatible with value .
   3. Initialize type/language to @language , and type/language value to @null . These two variables will keep track of the preferred type mapping or language mapping for a term , based on what is compatible with value .
   4. If value is a JSON object that contains the key @index , then append the value @index to containers .
   5. If reverse is true , set type/language to @type , type/language value to @reverse , and append @set to containers .
   6. Otherwise, if value is a list object , then set type/language and type/language value to the most specific values that work for all items in the list as follows:
      1. If @index is a not key in value , then append @list to containers .
      2. Initialize list to the array associated with the key @list in value .
      3. Initialize common type and common language to null . If list is empty, set common language to default language .
      4. For each item in list :
         1. Initialize item language to @none and item type to @none .
         2. If item contains the key @value :
            1. If item contains the key @language , then set item language to its associated value.
            2. Otherwise, if item contains the key @type , set item type to its associated value.
            3. Otherwise, set item language to @null .
         3. Otherwise, set item type to @id .
         4. If common language is null , set it to item language .
         5. Otherwise, if item language does not equal common language and item contains the key @value , then set common language to @none because list items have conflicting languages.
         6. If common type is null , set it to item type .
         7. Otherwise, if item type does not equal common type , then set common type to @none because list items have conflicting types.
         8. If common language is @none and common type is @none , then stop processing items in the list because it has been detected that there is no common language or type amongst the items.
      5. If common language is null , set it to @none .
      6. If common type is null , set it to @none .
      7. If common type is not @none then set type/language to @type and type/language value to common type .
      8. Otherwise, set type/language value to common language .
   7. Otherwise:
      1. If value is a value object :
         1. If value contains the key @language and does not contain the key @index , then set type/language value to its associated value and append @language to containers .
         2. Otherwise, if value contains the key @type , then set type/language value to its associated value and set type/language to @type .
      2. Otherwise, set type/language to @type and set type/language value to @id .
      3. Append @set to containers .
   8. Append @none to containers . This represents the non-existence of a container mapping , and it will be the last container mapping value to be checked as it is the most generic.
   9. If type/language value is null , set it to @null . This is the key under which null values are stored in the inverse context entry .
   10. Initialize preferred values to an empty array . This array will indicate, in order, the preferred values for a term's type mapping or language mapping .
   11. If type/language value is @reverse , append @reverse to preferred values .
   12. If type/language value is @id or @reverse and value has an @id member:
       1. If the result of using the IRI compaction algorithm , passing active context , inverse context , the value associated with the @id key in value for iri , true for vocab , and true for document relative has a term definition in the active context with an IRI mapping that equals the value associated with the @id key in value , then append @vocab , @id , and @none , in that order, to preferred values .
       2. Otherwise, append @id , @vocab , and @none , in that order, to preferred values .
   13. Otherwise, append type/language value and @none , in that order, to preferred values .
   14. Initialize term to the result of the Term Selection algorithm , passing inverse context , iri , containers , type/language , and preferred values .
   15. If term is not null , return term .
3. At this point, there is no simple term that iri can be compacted to. If vocab is true and active context has a vocabulary mapping :
   1. If iri begins with the vocabulary mapping's value but is longer, then initialize suffix to the substring of iri that does not match. If suffix does not have a term definition in active context , then return suffix .
4. The iri could not be compacted using the active context's vocabulary mapping . Try to create a compact IRI , starting by initializing compact IRI to null . This variable will be used to tore the created compact IRI , if any.
5. For each key term and value term definition in the active context :
   1. If the term contains a colon ( : ), then continue to the next term because terms with colons can't be used as prefixes .
   2. If the term definition is null , its IRI mapping equals iri , or its IRI mapping is not a substring at the beginning of iri , the term cannot be used as a prefix because it is not a partial match with iri . Continue with the next term .
   3. Initialize candidate by concatenating term , a colon ( : ), and the substring of iri that follows after the value of the term definition's IRI mapping .
   4. If either compact IRI is null or candidate is shorter or the same length but lexicographically less than compact IRI and candidate does not have a term definition in active context or if the term definition has an IRI mapping that equals iri and value is null , set compact IRI to candidate .
6. If compact IRI is not null , return compact IRI .
7. If vocab is false then transform iri to a relative IRI using the document's base IRI .
8. Finally, return iri as is.

Algorithm

This algorithm has five required inputs. They are: an inverse context , a keyword or IRI iri , an array containers that represents an ordered list of preferred container mappings , a string type/language that indicates whether to look for a term with a matching type mapping or language mapping , and an array representing an ordered list of preferred values for the type mapping or language mapping to look for.

1. Initialize container map to the value associated with iri in the inverse context .
2. For each item container in containers :
   1. If container is not a key in container map , then there is no term with a matching container mapping for it, so continue to the next container .
   2. Initialize type/language map to the value associated with the container member in container map .
   3. Initialize value map to the value associated with type/language member in type/language map .
   4. For each item in preferred values :
      1. If item is not a key in value map , then there is no term with a matching type mapping or language mapping , so continue to the next item .
      2. Otherwise, a matching term has been found, return the value associated with the item member in value map .
3. No matching term has been found. Return null .

Algorithm

This algorithm has four required inputs: an active context , an inverse context , an active property , and a value to be compacted.

1. Initialize number members to the number of members value contains.
2. If value has an @index member and the container mapping associated to active property is set to @index , decrease number members by 1 .
3. If number members is greater than 2 , return value as it cannot be compacted.
4. If value has an @id member:
   1. If number members is 1 and the type mapping of active property is set to @id , return the result of using the IRI compaction algorithm , passing active context , inverse context , and the value of the @id member for iri .
   2. Otherwise, if number members is 1 and the type mapping of active property is set to @vocab , return the result of using the IRI compaction algorithm , passing active context , inverse context , the value of the @id member for iri , and true for vocab .
   3. Otherwise, return value as is.
5. Otherwise, if value has an @type member whose value matches the type mapping of active property , return the value associated with the @value member of value .
6. Otherwise, if value has an @language member whose value matches the language mapping of active property , return the value associated with the @value member of value .
7. Otherwise, if number members equals 1 and either the value of the @value member is not a string , or the active context has no default language , or the language mapping of active property is set to null ,, return the value associated with the @value member.
8. Otherwise, return value as is.

Algorithm

The algorithm takes two input variables, an element to flatten and an optional context used to compact the flattened document. If not passed, context is set to null .

1. Initialize node map to a JSON object consisting of a single member whose key is @default and whose value is an empty JSON object .
2. Perform the Node Map Generation algorithm , passing element and node map .
3. Initialize default graph to the value of the @default member of node map , which is a JSON object representing the default graph .
4. For each key-value pair graph name - graph in node map where graph name is not @default , perform the following steps:
   1. If default graph does not have a graph name member, create one and initialize its value to a JSON object consisting of an @id member whose value is set to graph name .
   2. Reference the value associated with the graph name member in default graph using the variable entry .
   3. Add an @graph member to entry and set it to an empty array .
   4. For each id - node pair in graph ordered by id , add node to the @graph member of entry .
5. Initialize an empty array flattened .
6. For each id - node pair in default graph ordered by id , add node to flattened .
7. If context is null , return flattened .
8. Otherwise, return the result of compacting flattened according the Compaction algorithm passing context ensuring that the compaction result uses has only the @graph keyword (or its alias) at the top-level, top-level other than @context , even if the context is empty or if there is only one element to put in the @graph array . This ensures that the returned document has a deterministic structure.

Algorithm

The algorithm takes as input an expanded JSON-LD document element and a reference to a JSON object node map . Furthermore it has the optional parameters active graph (which defaults to @default ), an active subject , active property , and a reference to a JSON object list . If not passed, active subject , active property , and list are set to null .

1. If element is an array, process each item in element as follows and then return:
   1. Run this algorithm recursively by passing item for element , node map , active graph , active subject , active property , and list .
2. Otherwise element is a JSON object . Reference the JSON object which is the value of the active graph member of node map using the variable graph . If the active subject is null , set node to null otherwise reference the active subject member of graph using the variable node .
3. If element has an @type member, perform for each item the following steps:
   1. If item is a blank node identifier , replace it with a newly generated blank node identifier passing item for identifier .
   2. If graph has no member item , create one and initialize its value to a JSON object consisting of a single member @id whose value is item .
4. If element has an @value member, perform the following steps:
   1. If list is null :
      1. If node does not have an active property member, create one and initialize its value to an array containing element .
      2. Otherwise, compare element against every item in the array associated with the active property member of node . If there is no item equivalent to element , append element to the array . Two JSON objects are considered equal if they have equivalent key-value pairs.
   2. Otherwise, append element to the @list member of list .
5. Otherwise, if element has an @list member, perform the following steps:
   1. Initialize a new JSON object result consisting of a single member @list whose value is initialized to an empty array .
   2. Recursively call this algorithm passing the value of element's @list member for element , active graph , active subject , active property , and result for list .
   3. Append result to the the value of the active property member of node .
6. Otherwise element is a node object , perform the following steps:
   1. If element has an @id member, set id to its value and remove the member from element . If id is a blank node identifier , replace it with a newly generated blank node identifier passing id for identifier .
   2. Otherwise, set id to the result of the Generate Blank Node Identifier algorithm passing null for identifier .
   3. If graph does not contain a member id , create one and initialize its value to a JSON object consisting of a single member @id whose value is id .
   4. If active property is not null , perform the following steps:
      1. Create a new JSON object reference consisting of a single member @id whose value is id .
      2. If list is null :
         1. If node does not have an active property member, create one and initialize its value to an array containing reference .
         2. Otherwise, compare reference against every item in the array associated with the active property member of node . If there is no item equivalent to reference , append reference to the array . Two JSON objects are considered equal if they have equivalent key-value pairs.
      3. Otherwise, append element to the @list member of list .
   5. Reference the value of the id member of graph using the variable node .
   6. If element has an @type key, append each item of its associated array to the array associated with the @type key of node unless it is already in that array . Finally remove the @type member from element .
   7. If element has an @index member, set the @index member of node to its value. If node has already an @index member with a different value, a conflicting indexes error has been detected and processing is aborted. Otherwise, continue by removing the @index member from element .
   8. If element has an @reverse member:
      1. Create a JSON object referenced node with a single member @id whose value is id .
      2. Set reverse map to the value of the @reverse member of element .
      3. For each key-value pair property - values in reverse map :
         1. For each value of values :
            1. If value has a property member, append referenced node to its value; otherwise create a property member whose value is an array containing referenced node .
            2. Recursively invoke this algorithm passing value for element , node map , and active graph .
      4. Remove the @reverse member from element .
   9. If element has an @graph member, recursively invoke this algorithm passing the value of the @graph member for element , node map , and id for active graph before removing the @graph member from element .
   10. Finally, for each key-value pair property - value in element ordered by property perform the following steps:
       1. If property is a blank node identifier , replace it with a newly generated blank node identifier passing property for identifier .
       2. If node does not have a property member, create one and initialize its value to an empty array .
       3. Recursively invoke this algorithm passing value for element , node map , active graph , id for active subject , property for active property , and list .

Algorithm

The algorithm takes a single input variable identifier which may be null . Between its executions, the algorithm needs to keep an identifier map to relabel existing blank node identifiers consistently and a counter to generate new blank node identifiers . The counter is initialized to 0 by default.

1. If identifier is not null and has an entry in the identifier map , return the mapped identifier.
2. Otherwise, generate a new blank node identifier by concatenating the string _:b and counter .
3. Increment counter by 1 .
4. If identifier is not null , create a new entry for identifier in identifier map and set its value to the new blank node identifier .
5. Return the new blank node identifier .

Algorithm

The algorithm takes a JSON-LD document element and returns an RDF dataset .

1. Expand element according the Expansion algorithm .
2. Generate a node map according the Node Map Generation algorithm .
3. Initialize an empty RDF dataset dataset .
4. For each graph name and graph in node map :
   1. Initialize triples as an empty array .
   2. For each subject and node in graph :
      1. For each property and values in node :
         1. If property is @type , then for each type in values , append a triple composed of subject , rdf:type , and type to triples .
         2. Otherwise, if property is a keyword continue to the next property - values pair.
         3. Otherwise, property is an IRI or blank node identifier . For each item in values :
            1. If item is a list object , initialize list triples as an empty array and list head to the result of the List Conversion algorithm , passing the value associated with the @list key from item and list triples . Append first a triple composed of subject , property , and list head to triples and finally append all triples from list triples to triples .
            2. Otherwise, item is a value object or a node object . Append a triple composed of subject , property , and the result of using the Object to RDF Conversion algorithm passing item to triples .
   3. If graph name is @default , add triples to the default graph in dataset .
   4. Otherwise, create a named graph in dataset composed of graph name and add triples .
5. Return dataset .

Algorithm

The algorithm takes as its sole argument item which must be either a value object or node object .

1. If item is a node object return the IRI or blank node identifier associated with its @id member.
2. Otherwise, item is a value object . Initialize value to the value associated with the @value member in item .
3. Initialize datatype to the value associated with the @type member of item or null if item does not have such a member.
4. If value is true or false , set value to the string true or false which is the canonical lexical form as described in section 10.6 Data Round Tripping If datatype is null , set it to xsd:boolean .
5. Otherwise, if value is a number with fractions or value is a number and datatype equals xsd:double , convert value to a string in canonical lexical form of an xsd:double as defined in [ XMLSCHEMA11-2 ] and described in section 10.6 Data Round Tripping . If datatype is null , set it to xsd:double .
6. Otherwise, if value is a number without fractions or value is a number and datatype equals xsd:integer , convert value to a string in canonical lexical form of an xsd:integer as defined in [ XMLSCHEMA11-2 ] and described in section 10.6 Data Round Tripping . If datatype is null , set it to xsd:integer .
7. Otherwise, if datatype is null , set it to xsd:string or rdf:langString , depending on if item has an @language member.
8. Initialize literal as an RDF literal using value and datatype . If item has an @language member, add the value associated with the @language key as the language tag of literal .
9. Return literal .

Algorithm

The algorithm takes two inputs: an array list and an empty array list triples used for returning the generated triples .

1. If list is empty, return rdf:nil .
2. Otherwise, create an array bnodes composed of a newly generated blank node identifier for each entry in list .
3. Initialize an empty array list triples .
4. For each pair of subject from bnodes and item from list :
   1. Append a triple composed of subject , rdf:first , and the result of using th Object to RDF Conversion algorithm passing item to list triples .
   2. Set rest as the next entry in bnodes , or if that does not exist, rdf:nil . Append a triple composed of subject , rdf:rest , and rest to list triples .
5. Return the first blank node from bnodes or rdf:nil if bnodes is empty.

Algorithm

The algorithm takes two required inputs: an RDF dataset and a flag use native types that defaults to true .

1. Initialize default graph to a new JSON object consisting of two members, nodeMap and listMap , whose value is an an empty JSON object .
2. Initialize graph map to an empty a JSON object consisting of a single member @default whose value is set to reference default graph . Reference the nodeMap member of default graph using the variable references default graph nodes .
3. For each graph in RDF dataset :
   1. If graph is the default graph , set name to @default , otherwise to the graph name associated with graph .
   2. If graph map has no name member, create one and set its value to a to a new JSON object consisting of two members, nodeMap and listMap , whose value is an an empty JSON object .
   3. If graph is not the default graph and default graph nodes does not have a name member, create such a member and initialize its value to a new JSON object with a single member @id whose value is name .
   4. Reference the value of the name member in graph map using the variable graph object . Reference the value of the nodeMap member in graph object using the variable node map and the value of the listMap member using the variable list map .
   5. For each RDF triple in graph consisting of subject , predicate , and object :
      1. If predicate equals rdf:first , If list node map has no does not have a subject member, create one and initialize it its value to an empty a new JSON object . consisting of a single member @id whose value is set to subject .
      2. Initialize Reference the value of the first member of the subject member of in list node map to the result of using the RDF to Object Conversion algorithm , passing object and variable use native types node .
      3. Continue with the next RDF triple . If predicate equals rdf:rest : If list map has no subject member, create one and initialize it to an empty JSON object . Initialize the value of the rest member of the subject member of list map to object , which is either an absolute IRI or blank node identifier . Continue with the next RDF triple . If , does not equal rdf:nil , and node map does not have a an subject object member, create one and initialize its value to a new JSON object consisting of a single member @id whose value is set to subject . Reference the value of the subject member in node map using the variable node object .
      4. If predicate equals rdf:type , and object is an IRI or blank node identifier , append object to the value of the @type member of node . If no such member exists, create one and initialize it to an array whose only item is object . Finally, continue to the next RDF triple .
      5. If node object equals rdf:nil and predicate does not have an equal rdf:rest , set predicate value member, create one and initialize its to a new JSON object consisting of a single member @list whose value is set to an empty array .
      6. Set Otherwise, set value to the result of using the RDF to Object Conversion algorithm , passing object and use native types .
      7. If node does not have an predicate member, create one and initialize its value to an empty array .
      8. Add a reference to value to the to the array associated with the predicate member of node .
      9. If object is an IRI or a blank node identifier and predicate equals neither rdf:first nor rdf:rest , it might represent the head of a RDF list:
         1. If the list object member of node map has no an usages member, add a reference to object value member, to it; otherwise create one such a member and set its value to an empty JSON object . Set the head member of the object member of list map to array whose only item is a reference of value . This reference may be required later to replace the value in the predicate member of node with a list object . .
4. For each name and graph object in graph map :
   1. Reference Initialize subjects to an array whose items are the value keys of the listMap member in graph object using the variable list map .
   2. For each key-value pair item subject subj - of the array entry subjects , perform the following steps:
      1. If graph object does not have a subj member, it has been removed as it was part of a list. Continue with the next subj .
      2. Reference the value associated to of the listMap subj member of graph object : using the variable node .
      3. If entry node has not an head and an no first usages member it does or its value is not represent the head an array consisting of a list . Continue one item, continue with the next key-value pair. subj .
      4. Reference the only item of the array which is the value of the head usages member in of entry node using the variable value .
      5. Remove Initialize the variables list and list nodes to empty arrays .
      6. Initialize the subject to subj .
      7. As long as subject does not equal rdf:nil and list is not null , perform the following steps:
         1. If node is null ; the value of its @id member from does not begin with _: ; it has members other than @id , usages , rdf:first , and rdf:rest ; the value . Add of its rdf:first and member is not an array consisting of a single item; or the value of its @list rdf:rest member to is not an array containing a single item which is a JSON object that has an @id member, it is not a valid list node. Set value list and initialize it to an null.
         2. Otherwise:
            1. Add the item of the array containing which is the value of the first rdf:first member of entry node to list .
            2. While Add the value associated with of the rest @id member of entry is not rdf:nil : Set rest node to list nodes .
            3. The only item of the array which is the value of the rest rdf:rest member of entry . node is a JSON object . Set entry subject to the value associated with of its @id member.
            4. If graph object has a subject member, reference its value using the variable rest node member of ; otherwise set node to null .
            5. If list map . nodes contains subject a cycle has been detected, set list to null .
      8. Add the value associated If list is null , continue with the next subj .
      9. Remove the first @id member of from entry to the value .
      10. Add an @list member of to value and initialize it to list .
      11. For each subject in list nodes , remove the subject member of graph object .
5. Initialize an empty array result .
6. For each subject and node in default graph nodes ordered by subject :
   1. If graph map has an a subject member:
      1. Add a @graph member to node and initialize its value to an empty array .
      2. Reference the nodeMap member of the subject member of graph map using the variable node map . For each key-value pair s - n in the the node subject member of graph map ordered by s , append n to the @graph member of node . after removing its usages member.
   2. Append node to result . after removing its usages member.
7. Return result .

Algorithm

This algorithm takes two required inputs: a value to be converted to a JSON object and a flag use native types .

1. If value is an an IRI or a blank node identifier : If value equals rdf:nil return a new JSON object consisting of a single member @list whose value is set to an empty array . This is behavior is required by the Convert from RDF algorithm . Otherwise, , return a new JSON object consisting of a single member @id whose value is set to value .
2. Otherwise value is an RDF literal :
   1. Initialize a new empty JSON object result.
   2. Initialize converted value to value .
   3. Initialize type to null
   4. If use native types is true
      1. If the datatype IRI of value equals xsd:string , set converted value to the lexical form of value .
      2. Otherwise, if the datatype IRI of value equals xsd:boolean , set converted value to true if the lexical form of value matches true , or false if it matches false . If it matches neither, set type to xsd:boolean .
      3. Otherwise, if the datatype IRI of value equals xsd:integer or xsd:double and its lexical form is a valid xsd:integer or xsd:double according [ XMLSCHEMA11-2 ], set converted value to the result of converting the lexical form to a JSON number .
   5. Otherwise, if value is a language-tagged string add a member @language to result and set its value to the language tag of value .
   6. Otherwise, set type to the datatype IRI of value , unless it equals xsd:string which is ignored.
   7. Add a member @value to result whose value is set to converted value .
   8. If type is not null , add a member @type to result whose value is set to type .
   9. Return result .

Methods

compact

Compacts the given input using the context according to the steps in the Compaction algorithm :

1. Create a new Future future and return it. The following steps are then executed asynchronously.
2. If the passed input is a DOMString representing the IRI of a remote document, dereference it. If the retrieved document has a content type different than application/ld+json or application/json or if the document cannot be parsed as JSON, invoke reject the callback future passing an loading document failed error.
3. Initialize a new empty active context . The base IRI of the active context is set to the IRI of the currently being processed document, if available; otherwise to null . If set, the compactArrays overrides the base IRI .
4. If an expandContext has been passed, update the active context using the Context Processing algorithm , passing the expandContext as local context .
5. If the input has been retrieved and the response has a content type application/json and an HTTP Link Header [ RFC5988 ] using the http://www.w3.org/ns/json-ld#context link relation, update the active context using the Context Processing algorithm , passing the context referenced in the HTTP Link Header as local context .
6. Set expanded to the result of using the Expansion algorithm , passing the active context and input as element .
7. Set compacted to the result of using the Compaction algorithm , passing context , expanded as element , and if passed, the compactArrays flag in options .
8. Invoke callback , passing null for Accept the error future and passing compacted for document .

✘ callback JsonLdCallback ✘ ✘ A callback that is called when processing completed successfully on the given input , or a fatal error prevented processing from completing.

Parameter	Type	Nullable	Optional	Description
input	JsonLdInput any	✘	✘	The JSON-LD object or array of JSON-LD objects to perform the compaction upon or an IRI referencing the JSON-LD document to compact.
context	JsonLdContext	✘	✘	The context to use when compacting the input ; either in the form of a JSON object or as IRI .
options	JsonLdOptions	✘	✔	A set of options to configure the algorithms. This allows, e.g., to set the input document's base IRI .

Return type: void compact This method is the same as the compact method defined above but without the the options parameter: Parameter Type Nullable Optional Description input JsonLdInput ✘ ✘ The JSON-LD object or array of JSON-LD objects to perform the compaction upon or an IRI referencing the JSON-LD document to compact. context JsonLdContext ✘ ✘ The context to use when compacting the input ; either in the form of a JSON object or as IRI . callback JsonLdCallback ✘ ✘ A callback that is called when processing completed successfully on the given input , or a fatal error prevented processing from completing. Return type: void Future

expand

Expands the given input according to the steps in the Expansion algorithm :

1. Create a new Future future and return it. The following steps are then executed asynchronously.
2. If the passed input is a DOMString representing the IRI of a remote document, dereference it. If the retrieved document has a content type different than application/ld+json or application/json or if the document cannot be parsed as JSON, invoke reject the callback future passing an loading document failed error.
3. Initialize a new empty active context . The base IRI of the active context is set to the IRI of the currently being processed document, if available; otherwise to null . If set, the compactArrays overrides the base IRI .
4. If an expandContext has been passed, update the active context using the Context Processing algorithm , passing the expandContext as local context .
5. If the input has been retrieved and the response has a content type application/json and an HTTP Link Header [ RFC5988 ] using the http://www.w3.org/ns/json-ld#context link relation, update the active context using the Context Processing algorithm , passing the context referenced in the HTTP Link Header as local context .
6. Set expanded to the result of using the Expansion algorithm , passing the active context and input as element .
7. Invoke callback , passing null for Accept the error future and passing expanded for document .

✘ callback JsonLdCallback ✘ ✘ A callback that is called when processing completed successfully on the given input , or a fatal error prevented processing from completing. Return type: void expand This method is the same as the expand method defined above but without the the options parameter: Parameter Type Nullable Optional Description input JsonLdInput ✘ ✘ The JSON-LD object or array of JSON-LD objects to perform the expansion upon or an IRI referencing the JSON-LD document to expand. callback JsonLdCallback ✘ ✘ A callback that is called when processing completed successfully on the given input , or a fatal error prevented processing from completing.

Parameter	Type	Nullable	Optional	Description
input	JsonLdInput any	✘	✘	The JSON-LD object or array of JSON-LD objects to perform the expansion upon or an IRI referencing the JSON-LD document to expand.
options	JsonLdOptions	✘	✔	A set of options to configure the used algorithms such. This allows, e.g., to set the input document's base IRI .

Return type: void Future

flatten

Flattens the given input and compacts it using the passed context according to the steps in the Flattening algorithm :

1. Create a new Future future and return it. The following steps are then executed asynchronously.
2. If the passed input is a DOMString representing the IRI of a remote document, dereference it. If the retrieved document has a content type different than application/ld+json or application/json or if the document cannot be parsed as JSON, invoke reject the callback future passing an loading document failed error.
3. Initialize a new empty active context . The base IRI of the active context is set to the IRI of the currently being processed document, if available; otherwise to null . If set, the compactArrays overrides the base IRI .
4. If an expandContext has been passed, update the active context using the Context Processing algorithm , passing the expandContext as local context .
5. If the input has been retrieved and the response has a content type application/json and an HTTP Link Header [ RFC5988 ] using the http://www.w3.org/ns/json-ld#context link relation, update the active context using the Context Processing algorithm , passing the context referenced in the HTTP Link Header as local context .
6. Set expanded to the result of using the Expansion algorithm , passing the active context and input as element .
7. Initialize an empty identifier map and a counter (set to 0 ) to be used by the Generate Blank Node Identifier algorithm .
8. Set flattened to the result of using the Flattening algorithm , passing expanded as element , context , and if passed, the compactArrays flag in options (which is internally passed to the Compaction algorithm ).
9. Invoke callback , passing null for Accept the error future and passing flattened for document .

✘ ✘ callback JsonLdCallback ✘ ✘ A callback that is called when processing completed successfully on the given input , or a fatal error prevented processing from completing.

Parameter	Type	Nullable	Optional	Description
input	JsonLdInput any	✘	✘	The JSON-LD object or array of JSON-LD objects or an IRI referencing the JSON-LD document to flatten.
context	JsonLdContext	✔	✔	The context to use when compacting the flattened input ; either in the form of a JSON object or as IRI . If not passed or null is passed, the result will not be compacted but kept in expanded form.
options	JsonLdOptions	✘	✔	A set of options to configure the used algorithms such. This allows, e.g., to set the input document's base IRI .

Return type: void flatten This method is the same as the flatten method defined above but without the the options parameter: Parameter Type Nullable Optional Description input JsonLdInput ✘ ✘ The JSON-LD object or array of JSON-LD objects or an IRI referencing the JSON-LD document to flatten. context JsonLdContext ✔ ✘ The context to use when compacting the flattened input ; either in the form of a JSON object or as IRI . If null is passed, the result will not be compacted but kept in expanded form. callback JsonLdCallback ✘ ✘ A callback that is called when processing completed successfully on the given input , or a fatal error prevented processing from completing. Return type: void Future

Dictionary JsonLdOptions Members

base of type DOMString , nullable

The base IRI to use when expanding or compacting the document. This If set, this overrides the value of input if it is an document's IRI . If not specified and input is not an IRI , the base IRI defaults to the current document IRI if in a browser context, or the empty string if there is no document context. Feature at Risk 6 : Default value of base member in JsonLdOptions Note: This feature is "at risk" and may be removed from this specification based on feedback. Please send feedback to public-rdf-comments@w3.org . For the current status see features "at risk" in JSON-LD 1.0 The default value of base in JsonLdOptions implies that all IRIs that cannot be compacted otherwise are transformed to relative IRIs during compaction. To avoid that data is being lost, developers thus have to store the base IRI along with the compacted document. Based on implementer feedback, the Working Group may decide to change the default value to null , meaning that IRIs are not automatically compacted to relative IRIs.

compactArrays of type boolean , defaulting to true

If set to true , the JSON-LD processor replaces arrays with just one element with that element during compaction. If set to false , all arrays will remain arrays even if they have just one element.

expandContext of type (object? or DOMString) , defaulting to null

A context that is used to initialize the active context when expanding a document.

loadContext of type LoadContextCallback

The callback of the context loader to be used to retrieve remote contexts. If specified, it MUST be used to retrieve remote contexts; otherwise, if not specified, the processor's built-in context loader MUST be used.

processingMode of type DOMString , defaulting to "json-ld-1.0" "json-ld-1.0"

If set to json-ld-1.0 , the JSON-LD processor MUST produce exactly the same results as the algorithms defined in this specification. If set to another value, the JSON-LD processor is allowed to extend or modify the algorithms defined in this specification to enable application-specific optimizations. The definition of such optimizations is beyond the scope of this specification and thus not defined. Consequently, different implementations MAY implement different optimizations. Developers MUST NOT define modes beginning with json-ld as they are reserved for future versions of this specification.

LoadContextCallback

The LoadContextCallback defines the callback that custom context loaders have to implement to be used to retrieve remote contexts.

callback

LoadContextCallback

=

Future

(

DOMString

url

);

All errors MUST result in the Future being rejected with a JsonLdError whose code is set to loading remote context failed .

RemoteContext

The RemoteContext type is used by a LoadContextCallback to report processing errors to return information about a remote context.

dictionary RemoteContext {    DOMString url;    DOMString context;
};

JsonLdError

The JsonLdError type is used to report processing errors.

dictionary JsonLdError {
    JsonLdErrorCode code;
    DOMString?      message = null;
};

JsonLdErrorCode

The JsonLdErrorCode represents the collection of valid JSON-LD error codes.

enum JsonLdErrorCode {
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    "",
    ""

    "loading document failed",
    "list of lists",
    "invalid @index value",
    "conflicting indexes",
    "invalid @id value",
    "invalid local context",
    "loading remote context failed",
    "invalid remote context",
    "recursive context inclusion",
    "invalid base IRI",
    "invalid vocab mapping",
    "invalid default language",
    "keyword redefinition",
    "invalid term definition",
    "invalid reverse property",
    "invalid IRI mapping",
    "cyclic IRI mapping",
    "invalid keyword alias",
    "invalid type mapping",
    "invalid language mapping",
    "colliding keywords",
    "invalid container mapping",
    "invalid type value",
    "invalid value object",
    "invalid value object value",
    "invalid language-tagged string",
    "invalid language-tagged value",
    "invalid typed value",
    "invalid set or list object",
    "invalid language map value",
    "compaction to list of lists",
    "invalid reverse property map",
    "invalid @reverse value",
    "invalid reverse property value"

};