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

package/dist/cjs/index.cjs

@@ -1591,31 +1591,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;

package/dist/esm/index.mjs

@@ -1589,31 +1589,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;

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

@@ -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

@@ -1,5 +1,19 @@
 # @twin.org/data-json-ld - Changelog
 
+## [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

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-json-ld",
-	"version": "0.0.1-next.30",
+	"version": "0.0.1-next.31",
 	"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.31",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next",