npm - @twin.org/data-json-ld - Versions diffs - 0.0.1-next.30 → 0.0.1-next.32 - Mend

@twin.org/data-json-ld 0.0.1-next.30 → 0.0.1-next.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/dist/cjs/index.cjs +181 -68
package/dist/esm/index.mjs +183 -70
package/dist/types/models/jsonLdTypes.d.ts +8 -0
package/dist/types/utils/jsonLdProcessor.d.ts +6 -2
package/docs/changelog.md +28 -0
package/docs/reference/classes/JsonLdProcessor.md +12 -2
package/docs/reference/variables/JsonLdTypes.md +12 -0
package/package.json +2 -2

package/dist/cjs/index.cjs CHANGED Viewed

@@ -85,6 +85,14 @@ const JsonLdTypes = {
      * Represents JSON-LD Context Definition.
      */
     ContextDefinition: "JsonLdContextDefinition",
+    /**
+     * Represents JSON-LD Context Definition Element.
+     */
+    ContextDefinitionElement: "JsonLdContextDefinitionElement",
+    /**
+     * Represents JSON-LD Context Definition Root.
+     */
+    ContextDefinitionRoot: "JsonLdContextDefinitionRoot",
     /**
      * Represents JSON-LD Expanded Term Definition.
      */
@@ -124,7 +132,7 @@ const JsonLdTypes = {
 };
 var type$e = "string";
-var description$n = "Helper Types";
+var description$p = "Helper Types";
 var JsonLdContainerTypeSchema = {
 	type: type$e,
 	"enum": [
@@ -134,10 +142,10 @@ var JsonLdContainerTypeSchema = {
 	"@graph",
 	"@type"
 ],
-	description: description$n
+	description: description$p
 };
-var anyOf$8 = [
+var anyOf$a = [
 	{
 		type: "array",
 		minItems: 2,
@@ -311,10 +319,10 @@ var anyOf$8 = [
 		maxItems: 2
 	}
 ];
-var description$m = "Helper Types.";
+var description$o = "Helper Types.";
 var JsonLdContainerTypeArraySchema = {
-	anyOf: anyOf$8,
-	description: description$m
+	anyOf: anyOf$a,
+	description: description$o
 };
 var type$d = "object";
@@ -388,11 +396,45 @@ var additionalProperties$b = {
 		}
 	]
 };
-var description$l = "A context definition defines a local context in a node object.";
+var description$n = "A context definition defines a local context in a node object.";
 var JsonLdContextDefinitionSchema = {
 	type: type$d,
 	properties: properties$6,
 	additionalProperties: additionalProperties$b,
+	description: description$n
+};
+var anyOf$9 = [
+	{
+		type: "null"
+	},
+	{
+		type: "string"
+	},
+	{
+		$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinition"
+	}
+];
+var description$m = "A context definition element is used to define the types of a context definition.";
+var JsonLdContextDefinitionElementSchema = {
+	anyOf: anyOf$9,
+	description: description$m
+};
+var anyOf$8 = [
+	{
+		$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+	},
+	{
+		type: "array",
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		}
+	}
+];
+var description$l = "A context definition root is used to define the root of a context definition.";
+var JsonLdContextDefinitionRootSchema = {
+	anyOf: anyOf$8,
 	description: description$l
 };
@@ -1382,145 +1424,143 @@ class JsonLdDataTypes {
      */
     static registerTypes() {
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.Document}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.Document,
             jsonSchema: async () => JsonLdDocumentSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.Object}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.Object,
             jsonSchema: async () => JsonLdObjectSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.NodeObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.NodeObject,
             jsonSchema: async () => JsonLdNodeObjectSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.NodePrimitive}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.NodePrimitive,
             jsonSchema: async () => JsonLdNodePrimitiveSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.GraphObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.GraphObject,
             jsonSchema: async () => JsonLdGraphObjectSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ValueObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ValueObject,
             jsonSchema: async () => JsonLdValueObjectSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ListObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ListObject,
             jsonSchema: async () => JsonLdListObjectSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ListObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ListObject,
             jsonSchema: async () => JsonLdListObjectSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.SetObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.SetObject,
             jsonSchema: async () => JsonLdSetObjectSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.LanguageMap}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.LanguageMap,
             jsonSchema: async () => JsonLdLanguageMapSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.IndexMap}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.IndexMap,
             jsonSchema: async () => JsonLdIndexMapSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.IndexMapItem}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.IndexMapItem,
             jsonSchema: async () => JsonLdIndexMapItemSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.IdMap}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.IdMap,
             jsonSchema: async () => JsonLdIdMapSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.TypeMap}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.TypeMap,
             jsonSchema: async () => JsonLdTypeMapSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.IncludedBlock}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.IncludedBlock,
             jsonSchema: async () => JsonLdIncludedBlockSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContextDefinition}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ContextDefinition,
             jsonSchema: async () => JsonLdContextDefinitionSchema
         }));
+        dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContextDefinitionElement}`, () => ({
+            context: JsonLdContexts.ContextRoot,
+            type: JsonLdTypes.ContextDefinitionElement,
+            jsonSchema: async () => JsonLdContextDefinitionElementSchema
+        }));
+        dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContextDefinitionRoot}`, () => ({
+            context: JsonLdContexts.ContextRoot,
+            type: JsonLdTypes.ContextDefinitionRoot,
+            jsonSchema: async () => JsonLdContextDefinitionRootSchema
+        }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ExpandedTermDefinition}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ExpandedTermDefinition,
             jsonSchema: async () => JsonLdExpandedTermDefinitionSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.Keyword}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.Keyword,
             jsonSchema: async () => JsonLdKeywordSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ListOrSetItem}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ListOrSetItem,
             jsonSchema: async () => JsonLdListOrSetItemSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContainerType}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ContainerType,
             jsonSchema: async () => JsonLdContainerTypeSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContainerTypeArray}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ContainerTypeArray,
             jsonSchema: async () => JsonLdContainerTypeArraySchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.JsonPrimitive}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.JsonPrimitive,
             jsonSchema: async () => JsonLdJsonPrimitiveSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.JsonArray}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.JsonArray,
             jsonSchema: async () => JsonLdJsonArraySchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.JsonObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.JsonObject,
             jsonSchema: async () => JsonLdJsonObjectSchema
         }));
         dataCore.DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.JsonValue}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.JsonValue,
             jsonSchema: async () => JsonLdJsonValueSchema
         }));
     }
 }
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class to help with JSON LD.
- */
-class JsonLdHelper {
-    /**
-     * Validate a JSON-LD document.
-     * @param document The JSON-LD document to validate.
-     * @param validationFailures The list of validation failures to add to.
-     * @param validationMode The validation mode to use, defaults to either.
-     * @returns True if the document was valid.
-     */
-    static async validate(document, validationFailures, validationMode) {
-        if (core.Is.array(document)) {
-            // If the document is an array of nodes, validate each node
-            for (const node of document) {
-                await JsonLdHelper.validate(node, validationFailures, validationMode);
-            }
-        }
-        else if (core.Is.array(document["@graph"])) {
-            // If the graph is an array of nodes, validate each node
-            for (const node of document["@graph"]) {
-                await JsonLdHelper.validate(node, validationFailures, validationMode);
-            }
-        }
-        else if (core.Is.object(document)) {
-            // If the graph is a single node, then use the validate the node schema
-            const dataType = document["@type"];
-            if (core.Is.stringValue(dataType)) {
-                await dataCore.DataTypeHelper.validate("document", dataType, document, validationFailures, validationMode);
-            }
-        }
-        return validationFailures.length === 0;
-    }
-}
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1591,31 +1631,48 @@ class JsonLdProcessor {
     /**
      * Compact a document according to a particular context.
      * @param document The JSON-LD document to compact.
-     * @param context The context to compact the document to, if not provided will try and gather from the object.
+     * @param context The context to compact the document to, if not provided will use the one in the document.
+     * @param options The options for compacting the document.
+     * @param options.itemListOverride Whether to override the itemListElement context with a set, defaults to true.
      * @returns The compacted JSON-LD document.
      */
-    static async compact(document, context) {
+    static async compact(document, context, options) {
         try {
             if (core.Is.object(document)) {
-                if (core.Is.empty(context)) {
-                    context = {};
-                    if (core.Is.array(document)) {
-                        for (const node of document) {
-                            context = JsonLdProcessor.gatherContexts(node, context);
-                        }
-                    }
-                    else if (core.Is.array(document["@graph"])) {
-                        for (const node of document["@graph"]) {
-                            context = JsonLdProcessor.gatherContexts(node, context);
+                // If the user didn't provide a context, use the one from the document
+                if (core.Is.empty(context) && !core.Is.empty(document["@context"])) {
+                    context = document["@context"];
+                }
+                const overrideListElementOption = options?.itemListOverride ?? true;
+                let overrideContext;
+                if (overrideListElementOption) {
+                    // The compactArrays flag doesn't work with the current version of jsonld.js
+                    // For list results we standardise on ItemList and itemListElement
+                    // so we modify the schema.org type for itemListElement to be a set which bypasses the issue
+                    // https://github.com/digitalbazaar/jsonld.js/issues/247
+                    overrideContext = {
+                        itemListElement: {
+                            "@id": "http://schema.org/itemListElement",
+                            "@container": "@set",
+                            "@protected": true
                         }
+                    };
+                    if (core.Is.object(context) && "@context" in context) {
+                        // If the context is an object, we need to merge it with the override context
+                        context = JsonLdProcessor.combineContexts(context["@context"], overrideContext);
                     }
-                    else if (core.Is.object(document)) {
-                        context = JsonLdProcessor.gatherContexts(document, context);
+                    else {
+                        // If the context is a string or an array, we need to merge it with the override context
+                        context = JsonLdProcessor.combineContexts(context, overrideContext);
                     }
                 }
                 const compacted = await jsonLd.compact(core.ObjectHelper.removeEmptyProperties(document), context, {
                     documentLoader: JsonLdProcessor.getDocumentLoader()
                 });
+                if (!core.Is.empty(overrideContext)) {
+                    // Remove the override context from the compacted document
+                    compacted["@context"] = JsonLdProcessor.removeContexts(compacted["@context"], [overrideContext]);
+                }
                 return compacted;
             }
             return document;
@@ -1829,17 +1886,34 @@ class JsonLdProcessor {
                 break;
             }
         }
-        // Cache the results for an hour
-        const response = await web.FetchHelper.fetchJson(JsonLdProcessor._CLASS_NAME, url, web.HttpMethod.GET, undefined, {
-            cacheTtlMs: JsonLdProcessor.getCacheLimit(),
-            headers: {
-                [web.HeaderTypes.Accept]: `${web.MimeTypes.JsonLd},${web.MimeTypes.Json}`
+        try {
+            const response = await web.FetchHelper.fetchJson(JsonLdProcessor._CLASS_NAME, url, web.HttpMethod.GET, undefined, {
+                cacheTtlMs: JsonLdProcessor.getCacheLimit(),
+                headers: {
+                    [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
+                }
+            });
+            return {
+                documentUrl: url,
+                document: response
+            };
+        }
+        catch (err) {
+            const error = core.BaseError.fromError(err);
+            if (error.message.includes("is not valid JSON")) {
+                const response = await web.FetchHelper.fetchJson(JsonLdProcessor._CLASS_NAME, url, web.HttpMethod.GET, undefined, {
+                    cacheTtlMs: JsonLdProcessor.getCacheLimit(),
+                    headers: {
+                        [web.HeaderTypes.Accept]: web.MimeTypes.Json
+                    }
+                });
+                return {
+                    documentUrl: url,
+                    document: response
+                };
             }
-        });
-        return {
-            documentUrl: url,
-            document: response
-        };
+            throw err;
+        }
     }
     /**
      * Handle common errors.
@@ -1858,6 +1932,45 @@ class JsonLdProcessor {
     }
 }
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with JSON LD.
+ */
+class JsonLdHelper {
+    /**
+     * Validate a JSON-LD document.
+     * @param document The JSON-LD document to validate.
+     * @param validationFailures The list of validation failures to add to.
+     * @param validationMode The validation mode to use, defaults to either.
+     * @returns True if the document was valid.
+     */
+    static async validate(document, validationFailures, validationMode) {
+        if (core.Is.array(document)) {
+            // If the document is an array of nodes, validate each node
+            for (const node of document) {
+                await JsonLdHelper.validate(node, validationFailures, validationMode);
+            }
+        }
+        else if (core.Is.array(document["@graph"])) {
+            // If the graph is an array of nodes, validate each node
+            for (const node of document["@graph"]) {
+                await JsonLdHelper.validate(node, validationFailures, validationMode);
+            }
+        }
+        else if (core.Is.object(document)) {
+            // Expand the document to ensure we have the full context for types
+            // As the data types in the factories are not always fully qualified
+            const expandedDoc = await JsonLdProcessor.expand(document);
+            const expandedDataType = core.ArrayHelper.fromObjectOrArray(expandedDoc[0]["@type"]);
+            if (core.Is.arrayValue(expandedDataType)) {
+                await dataCore.DataTypeHelper.validate("document", expandedDataType[0], document, validationFailures, validationMode);
+            }
+        }
+        return validationFailures.length === 0;
+    }
+}
 exports.JsonLdContexts = JsonLdContexts;
 exports.JsonLdDataTypes = JsonLdDataTypes;
 exports.JsonLdHelper = JsonLdHelper;

package/dist/esm/index.mjs CHANGED Viewed

@@ -1,6 +1,6 @@
 import { DataTypeHandlerFactory, DataTypeHelper } from '@twin.org/data-core';
-import { Is, SharedStore, ObjectHelper, GeneralError } from '@twin.org/core';
-import { FetchHelper, HttpMethod, MimeTypes, HeaderTypes } from '@twin.org/web';
+import { SharedStore, Is, ObjectHelper, GeneralError, BaseError, ArrayHelper } from '@twin.org/core';
+import { FetchHelper, HttpMethod, HeaderTypes, MimeTypes } from '@twin.org/web';
 import jsonLd from 'jsonld';
 // Copyright 2024 IOTA Stiftung.
@@ -83,6 +83,14 @@ const JsonLdTypes = {
      * Represents JSON-LD Context Definition.
      */
     ContextDefinition: "JsonLdContextDefinition",
+    /**
+     * Represents JSON-LD Context Definition Element.
+     */
+    ContextDefinitionElement: "JsonLdContextDefinitionElement",
+    /**
+     * Represents JSON-LD Context Definition Root.
+     */
+    ContextDefinitionRoot: "JsonLdContextDefinitionRoot",
     /**
      * Represents JSON-LD Expanded Term Definition.
      */
@@ -122,7 +130,7 @@ const JsonLdTypes = {
 };
 var type$e = "string";
-var description$n = "Helper Types";
+var description$p = "Helper Types";
 var JsonLdContainerTypeSchema = {
 	type: type$e,
 	"enum": [
@@ -132,10 +140,10 @@ var JsonLdContainerTypeSchema = {
 	"@graph",
 	"@type"
 ],
-	description: description$n
+	description: description$p
 };
-var anyOf$8 = [
+var anyOf$a = [
 	{
 		type: "array",
 		minItems: 2,
@@ -309,10 +317,10 @@ var anyOf$8 = [
 		maxItems: 2
 	}
 ];
-var description$m = "Helper Types.";
+var description$o = "Helper Types.";
 var JsonLdContainerTypeArraySchema = {
-	anyOf: anyOf$8,
-	description: description$m
+	anyOf: anyOf$a,
+	description: description$o
 };
 var type$d = "object";
@@ -386,11 +394,45 @@ var additionalProperties$b = {
 		}
 	]
 };
-var description$l = "A context definition defines a local context in a node object.";
+var description$n = "A context definition defines a local context in a node object.";
 var JsonLdContextDefinitionSchema = {
 	type: type$d,
 	properties: properties$6,
 	additionalProperties: additionalProperties$b,
+	description: description$n
+};
+var anyOf$9 = [
+	{
+		type: "null"
+	},
+	{
+		type: "string"
+	},
+	{
+		$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinition"
+	}
+];
+var description$m = "A context definition element is used to define the types of a context definition.";
+var JsonLdContextDefinitionElementSchema = {
+	anyOf: anyOf$9,
+	description: description$m
+};
+var anyOf$8 = [
+	{
+		$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+	},
+	{
+		type: "array",
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		}
+	}
+];
+var description$l = "A context definition root is used to define the root of a context definition.";
+var JsonLdContextDefinitionRootSchema = {
+	anyOf: anyOf$8,
 	description: description$l
 };
@@ -1380,145 +1422,143 @@ class JsonLdDataTypes {
      */
     static registerTypes() {
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.Document}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.Document,
             jsonSchema: async () => JsonLdDocumentSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.Object}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.Object,
             jsonSchema: async () => JsonLdObjectSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.NodeObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.NodeObject,
             jsonSchema: async () => JsonLdNodeObjectSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.NodePrimitive}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.NodePrimitive,
             jsonSchema: async () => JsonLdNodePrimitiveSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.GraphObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.GraphObject,
             jsonSchema: async () => JsonLdGraphObjectSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ValueObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ValueObject,
             jsonSchema: async () => JsonLdValueObjectSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ListObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ListObject,
             jsonSchema: async () => JsonLdListObjectSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ListObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ListObject,
             jsonSchema: async () => JsonLdListObjectSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.SetObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.SetObject,
             jsonSchema: async () => JsonLdSetObjectSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.LanguageMap}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.LanguageMap,
             jsonSchema: async () => JsonLdLanguageMapSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.IndexMap}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.IndexMap,
             jsonSchema: async () => JsonLdIndexMapSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.IndexMapItem}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.IndexMapItem,
             jsonSchema: async () => JsonLdIndexMapItemSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.IdMap}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.IdMap,
             jsonSchema: async () => JsonLdIdMapSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.TypeMap}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.TypeMap,
             jsonSchema: async () => JsonLdTypeMapSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.IncludedBlock}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.IncludedBlock,
             jsonSchema: async () => JsonLdIncludedBlockSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContextDefinition}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ContextDefinition,
             jsonSchema: async () => JsonLdContextDefinitionSchema
         }));
+        DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContextDefinitionElement}`, () => ({
+            context: JsonLdContexts.ContextRoot,
+            type: JsonLdTypes.ContextDefinitionElement,
+            jsonSchema: async () => JsonLdContextDefinitionElementSchema
+        }));
+        DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContextDefinitionRoot}`, () => ({
+            context: JsonLdContexts.ContextRoot,
+            type: JsonLdTypes.ContextDefinitionRoot,
+            jsonSchema: async () => JsonLdContextDefinitionRootSchema
+        }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ExpandedTermDefinition}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ExpandedTermDefinition,
             jsonSchema: async () => JsonLdExpandedTermDefinitionSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.Keyword}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.Keyword,
             jsonSchema: async () => JsonLdKeywordSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ListOrSetItem}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ListOrSetItem,
             jsonSchema: async () => JsonLdListOrSetItemSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContainerType}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ContainerType,
             jsonSchema: async () => JsonLdContainerTypeSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.ContainerTypeArray}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.ContainerTypeArray,
             jsonSchema: async () => JsonLdContainerTypeArraySchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.JsonPrimitive}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.JsonPrimitive,
             jsonSchema: async () => JsonLdJsonPrimitiveSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.JsonArray}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.JsonArray,
             jsonSchema: async () => JsonLdJsonArraySchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.JsonObject}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.JsonObject,
             jsonSchema: async () => JsonLdJsonObjectSchema
         }));
         DataTypeHandlerFactory.register(`${JsonLdContexts.ContextRoot}${JsonLdTypes.JsonValue}`, () => ({
+            context: JsonLdContexts.ContextRoot,
             type: JsonLdTypes.JsonValue,
             jsonSchema: async () => JsonLdJsonValueSchema
         }));
     }
 }
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class to help with JSON LD.
- */
-class JsonLdHelper {
-    /**
-     * Validate a JSON-LD document.
-     * @param document The JSON-LD document to validate.
-     * @param validationFailures The list of validation failures to add to.
-     * @param validationMode The validation mode to use, defaults to either.
-     * @returns True if the document was valid.
-     */
-    static async validate(document, validationFailures, validationMode) {
-        if (Is.array(document)) {
-            // If the document is an array of nodes, validate each node
-            for (const node of document) {
-                await JsonLdHelper.validate(node, validationFailures, validationMode);
-            }
-        }
-        else if (Is.array(document["@graph"])) {
-            // If the graph is an array of nodes, validate each node
-            for (const node of document["@graph"]) {
-                await JsonLdHelper.validate(node, validationFailures, validationMode);
-            }
-        }
-        else if (Is.object(document)) {
-            // If the graph is a single node, then use the validate the node schema
-            const dataType = document["@type"];
-            if (Is.stringValue(dataType)) {
-                await DataTypeHelper.validate("document", dataType, document, validationFailures, validationMode);
-            }
-        }
-        return validationFailures.length === 0;
-    }
-}
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1589,31 +1629,48 @@ class JsonLdProcessor {
     /**
      * Compact a document according to a particular context.
      * @param document The JSON-LD document to compact.
-     * @param context The context to compact the document to, if not provided will try and gather from the object.
+     * @param context The context to compact the document to, if not provided will use the one in the document.
+     * @param options The options for compacting the document.
+     * @param options.itemListOverride Whether to override the itemListElement context with a set, defaults to true.
      * @returns The compacted JSON-LD document.
      */
-    static async compact(document, context) {
+    static async compact(document, context, options) {
         try {
             if (Is.object(document)) {
-                if (Is.empty(context)) {
-                    context = {};
-                    if (Is.array(document)) {
-                        for (const node of document) {
-                            context = JsonLdProcessor.gatherContexts(node, context);
-                        }
-                    }
-                    else if (Is.array(document["@graph"])) {
-                        for (const node of document["@graph"]) {
-                            context = JsonLdProcessor.gatherContexts(node, context);
+                // If the user didn't provide a context, use the one from the document
+                if (Is.empty(context) && !Is.empty(document["@context"])) {
+                    context = document["@context"];
+                }
+                const overrideListElementOption = options?.itemListOverride ?? true;
+                let overrideContext;
+                if (overrideListElementOption) {
+                    // The compactArrays flag doesn't work with the current version of jsonld.js
+                    // For list results we standardise on ItemList and itemListElement
+                    // so we modify the schema.org type for itemListElement to be a set which bypasses the issue
+                    // https://github.com/digitalbazaar/jsonld.js/issues/247
+                    overrideContext = {
+                        itemListElement: {
+                            "@id": "http://schema.org/itemListElement",
+                            "@container": "@set",
+                            "@protected": true
                         }
+                    };
+                    if (Is.object(context) && "@context" in context) {
+                        // If the context is an object, we need to merge it with the override context
+                        context = JsonLdProcessor.combineContexts(context["@context"], overrideContext);
                     }
-                    else if (Is.object(document)) {
-                        context = JsonLdProcessor.gatherContexts(document, context);
+                    else {
+                        // If the context is a string or an array, we need to merge it with the override context
+                        context = JsonLdProcessor.combineContexts(context, overrideContext);
                     }
                 }
                 const compacted = await jsonLd.compact(ObjectHelper.removeEmptyProperties(document), context, {
                     documentLoader: JsonLdProcessor.getDocumentLoader()
                 });
+                if (!Is.empty(overrideContext)) {
+                    // Remove the override context from the compacted document
+                    compacted["@context"] = JsonLdProcessor.removeContexts(compacted["@context"], [overrideContext]);
+                }
                 return compacted;
             }
             return document;
@@ -1827,17 +1884,34 @@ class JsonLdProcessor {
                 break;
             }
         }
-        // Cache the results for an hour
-        const response = await FetchHelper.fetchJson(JsonLdProcessor._CLASS_NAME, url, HttpMethod.GET, undefined, {
-            cacheTtlMs: JsonLdProcessor.getCacheLimit(),
-            headers: {
-                [HeaderTypes.Accept]: `${MimeTypes.JsonLd},${MimeTypes.Json}`
+        try {
+            const response = await FetchHelper.fetchJson(JsonLdProcessor._CLASS_NAME, url, HttpMethod.GET, undefined, {
+                cacheTtlMs: JsonLdProcessor.getCacheLimit(),
+                headers: {
+                    [HeaderTypes.Accept]: MimeTypes.JsonLd
+                }
+            });
+            return {
+                documentUrl: url,
+                document: response
+            };
+        }
+        catch (err) {
+            const error = BaseError.fromError(err);
+            if (error.message.includes("is not valid JSON")) {
+                const response = await FetchHelper.fetchJson(JsonLdProcessor._CLASS_NAME, url, HttpMethod.GET, undefined, {
+                    cacheTtlMs: JsonLdProcessor.getCacheLimit(),
+                    headers: {
+                        [HeaderTypes.Accept]: MimeTypes.Json
+                    }
+                });
+                return {
+                    documentUrl: url,
+                    document: response
+                };
             }
-        });
-        return {
-            documentUrl: url,
-            document: response
-        };
+            throw err;
+        }
     }
     /**
      * Handle common errors.
@@ -1856,4 +1930,43 @@ class JsonLdProcessor {
     }
 }
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with JSON LD.
+ */
+class JsonLdHelper {
+    /**
+     * Validate a JSON-LD document.
+     * @param document The JSON-LD document to validate.
+     * @param validationFailures The list of validation failures to add to.
+     * @param validationMode The validation mode to use, defaults to either.
+     * @returns True if the document was valid.
+     */
+    static async validate(document, validationFailures, validationMode) {
+        if (Is.array(document)) {
+            // If the document is an array of nodes, validate each node
+            for (const node of document) {
+                await JsonLdHelper.validate(node, validationFailures, validationMode);
+            }
+        }
+        else if (Is.array(document["@graph"])) {
+            // If the graph is an array of nodes, validate each node
+            for (const node of document["@graph"]) {
+                await JsonLdHelper.validate(node, validationFailures, validationMode);
+            }
+        }
+        else if (Is.object(document)) {
+            // Expand the document to ensure we have the full context for types
+            // As the data types in the factories are not always fully qualified
+            const expandedDoc = await JsonLdProcessor.expand(document);
+            const expandedDataType = ArrayHelper.fromObjectOrArray(expandedDoc[0]["@type"]);
+            if (Is.arrayValue(expandedDataType)) {
+                await DataTypeHelper.validate("document", expandedDataType[0], document, validationFailures, validationMode);
+            }
+        }
+        return validationFailures.length === 0;
+    }
+}
 export { JsonLdContexts, JsonLdDataTypes, JsonLdHelper, JsonLdProcessor, JsonLdTypes };

package/dist/types/models/jsonLdTypes.d.ts CHANGED Viewed

@@ -62,6 +62,14 @@ export declare const JsonLdTypes: {
      * Represents JSON-LD Context Definition.
      */
     readonly ContextDefinition: "JsonLdContextDefinition";
+    /**
+     * Represents JSON-LD Context Definition Element.
+     */
+    readonly ContextDefinitionElement: "JsonLdContextDefinitionElement";
+    /**
+     * Represents JSON-LD Context Definition Root.
+     */
+    readonly ContextDefinitionRoot: "JsonLdContextDefinitionRoot";
     /**
      * Represents JSON-LD Expanded Term Definition.
      */

package/dist/types/utils/jsonLdProcessor.d.ts CHANGED Viewed

@@ -45,10 +45,14 @@ export declare class JsonLdProcessor {
     /**
      * Compact a document according to a particular context.
      * @param document The JSON-LD document to compact.
-     * @param context The context to compact the document to, if not provided will try and gather from the object.
+     * @param context The context to compact the document to, if not provided will use the one in the document.
+     * @param options The options for compacting the document.
+     * @param options.itemListOverride Whether to override the itemListElement context with a set, defaults to true.
      * @returns The compacted JSON-LD document.
      */
-    static compact<T>(document: T, context?: IJsonLdContextDefinitionRoot): Promise<T>;
+    static compact<T>(document: T, context?: IJsonLdContextDefinitionRoot, options?: {
+        itemListOverride: boolean;
+    }): Promise<T>;
     /**
      * Expand a document, removing its context.
      * @param compacted The compacted JSON-LD document to expand.

package/docs/changelog.md CHANGED Viewed

@@ -1,5 +1,33 @@
 # @twin.org/data-json-ld - Changelog
+## [0.0.1-next.32](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.31...data-json-ld-v0.0.1-next.32) (2025-05-28)
+### Features
+* use fully qualified names for data type lookups ([b7b5c74](https://github.com/twinfoundation/data/commit/b7b5c746b0180a87baa976f6a7a76cedd53d8ff7))
+### Dependencies
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.31 to 0.0.1-next.32
+## [0.0.1-next.31](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.30...data-json-ld-v0.0.1-next.31) (2025-05-08)
+### Bug Fixes
+* itemListElement compaction override ([d908a10](https://github.com/twinfoundation/data/commit/d908a1043d7792e31b3101221d17850757b6c2a6))
+### Dependencies
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.30 to 0.0.1-next.31
 ## [0.0.1-next.30](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.29...data-json-ld-v0.0.1-next.30) (2025-04-17)

package/docs/reference/classes/JsonLdProcessor.md CHANGED Viewed

@@ -128,7 +128,7 @@ The registered redirects.
 ### compact()
-> `static` **compact**\<`T`\>(`document`, `context?`): `Promise`\<`T`\>
+> `static` **compact**\<`T`\>(`document`, `context?`, `options?`): `Promise`\<`T`\>
 Compact a document according to a particular context.
@@ -150,7 +150,17 @@ The JSON-LD document to compact.
 [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
-The context to compact the document to, if not provided will try and gather from the object.
+The context to compact the document to, if not provided will use the one in the document.
+##### options?
+The options for compacting the document.
+###### itemListOverride
+`boolean`
+Whether to override the itemListElement context with a set, defaults to true.
 #### Returns

package/docs/reference/variables/JsonLdTypes.md CHANGED Viewed

@@ -96,6 +96,18 @@ Represents JSON-LD Included block.
 Represents JSON-LD Context Definition.
+### ContextDefinitionElement
+> `readonly` **ContextDefinitionElement**: `"JsonLdContextDefinitionElement"` = `"JsonLdContextDefinitionElement"`
+Represents JSON-LD Context Definition Element.
+### ContextDefinitionRoot
+> `readonly` **ContextDefinitionRoot**: `"JsonLdContextDefinitionRoot"` = `"JsonLdContextDefinitionRoot"`
+Represents JSON-LD Context Definition Root.
 ### ExpandedTermDefinition
 > `readonly` **ExpandedTermDefinition**: `"JsonLdExpandedTermDefinition"` = `"JsonLdExpandedTermDefinition"`

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-json-ld",
-	"version": "0.0.1-next.30",
+	"version": "0.0.1-next.32",
 	"description": "Models which define the structure of JSON LD",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/data-core": "0.0.1-next.30",
+		"@twin.org/data-core": "0.0.1-next.32",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next",