@twin.org/data-json-ld 0.0.1-next.4 → 0.0.1-next.5

package/dist/cjs/index.cjs

@@ -1403,6 +1403,96 @@ class JsonLdHelper {
         }
         return validationFailures.length === 0;
     }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * JSON-LD Processor.
+ */
+class JsonLdProcessor {
+    /**
+     * The class name.
+     * @internal
+     */
+    static _CLASS_NAME = "JsonLdProcessor";
+    /**
+     * Redirects to use during document resolution.
+     */
+    static _redirects = [];
+    /**
+     * The document loader to use.
+     */
+    static DOCUMENT_LOADER = async (url) => JsonLdProcessor.documentLoader(url);
+    /**
+     * 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.
+     * @returns The compacted JSON-LD document.
+     */
+    static async compact(document, context) {
+        try {
+            // There is a cast here because the jsonld types are not correct.
+            // A context definition can be an array or an object, but the types only allow an object.
+            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);
+                    }
+                }
+                else if (core.Is.object(document)) {
+                    context = JsonLdProcessor.gatherContexts(document, context);
+                }
+            }
+            const compacted = await jsonLd.compact(document, context, {
+                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+            });
+            return compacted;
+        }
+        catch (err) {
+            if (core.Is.object(err) &&
+                err.name === "jsonld.InvalidUrl") {
+                throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+            }
+            throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "compact", undefined, err);
+        }
+    }
+    /**
+     * Expand a document, removing its context.
+     * @param compacted The compacted JSON-LD document to expand.
+     * @returns The expanded JSON-LD document.
+     */
+    static async expand(compacted) {
+        try {
+            const expanded = await jsonLd.expand(compacted, {
+                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+            });
+            return expanded;
+        }
+        catch (err) {
+            if (core.Is.object(err) &&
+                err.name === "jsonld.InvalidUrl") {
+                throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+            }
+            throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "expand", undefined, err);
+        }
+    }
+    /**
+     * Add a redirect to use during document resolution.
+     * @param from The URL to redirect from.
+     * @param to The URL to redirect to.
+     */
+    static addRedirect(from, to) {
+        if (!this._redirects.some(r => r.from === from)) {
+            this._redirects.push({ from, to });
+        }
+    }
     /**
      * Extract a property from the JSON-LD.
      * @param nodeObject The JSON-LD node object to extract from.
@@ -1426,7 +1516,7 @@ class JsonLdHelper {
      * @param context2 The second JSON-LD context to combine.
      * @returns The combined context.
      */
-    static async combineContexts(context1, context2) {
+    static combineContexts(context1, context2) {
         const combinedContext = [];
         if (core.Is.string(context1)) {
             if (!combinedContext.includes(context1)) {
@@ -1474,77 +1564,31 @@ class JsonLdHelper {
         }
         return combinedContext;
     }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * JSON-LD Processor.
- */
-class JsonLdProcessor {
     /**
-     * The class name.
-     * @internal
+     * Gather all the contexts from the element and it's children.
+     * @param element The element to gather the contexts from.
+     * @param initial The initial context.
+     * @returns The combined contexts.
      */
-    static _CLASS_NAME = "JsonLdProcessor";
-    /**
-     * Redirects to use during document resolution.
-     */
-    static _redirects = [];
-    /**
-     * The document loader to use.
-     */
-    static DOCUMENT_LOADER = async (url) => JsonLdProcessor.documentLoader(url);
-    /**
-     * 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.
-     * @returns The compacted JSON-LD document.
-     */
-    static async compact(document, context) {
-        try {
-            const compacted = await jsonLd.compact(document, context ?? {}, {
-                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
-            });
-            return compacted;
+    static gatherContexts(element, initial) {
+        let combinedContexts = initial;
+        if (!core.Is.empty(element["@context"])) {
+            combinedContexts = JsonLdProcessor.combineContexts(initial, element["@context"]);
         }
-        catch (err) {
-            if (core.Is.object(err) &&
-                err.name === "jsonld.InvalidUrl") {
-                throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+        for (const prop of Object.keys(element)) {
+            const value = element[prop];
+            if (core.Is.object(value)) {
+                combinedContexts = this.gatherContexts(value, combinedContexts);
             }
-            throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "compact", undefined, err);
-        }
-    }
-    /**
-     * Expand a document, removing its context.
-     * @param compacted The compacted JSON-LD document to expand.
-     * @returns The expanded JSON-LD document.
-     */
-    static async expand(compacted) {
-        try {
-            const expanded = await jsonLd.expand(compacted, {
-                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
-            });
-            return expanded;
-        }
-        catch (err) {
-            if (core.Is.object(err) &&
-                err.name === "jsonld.InvalidUrl") {
-                throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+            else if (core.Is.array(value)) {
+                for (const item of value) {
+                    if (core.Is.object(item)) {
+                        combinedContexts = this.gatherContexts(item, combinedContexts);
+                    }
+                }
             }
-            throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "expand", undefined, err);
-        }
-    }
-    /**
-     * Add a redirect to use during document resolution.
-     * @param from The URL to redirect from.
-     * @param to The URL to redirect to.
-     */
-    static addRedirect(from, to) {
-        if (!this._redirects.some(r => r.from === from)) {
-            this._redirects.push({ from, to });
         }
+        return combinedContexts;
     }
     /**
      * Document loader which uses a caching mechanism.

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { DataTypeHandlerFactory, DataTypeHelper } from '@twin.org/data-core';
-import { Is, ObjectHelper, GeneralError } from '@twin.org/core';
+import { Is, GeneralError, ObjectHelper } from '@twin.org/core';
 import { FetchHelper, HttpMethod, MimeTypes } from '@twin.org/web';
 import jsonLd from 'jsonld';
 
@@ -1401,6 +1401,96 @@ class JsonLdHelper {
         }
         return validationFailures.length === 0;
     }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * JSON-LD Processor.
+ */
+class JsonLdProcessor {
+    /**
+     * The class name.
+     * @internal
+     */
+    static _CLASS_NAME = "JsonLdProcessor";
+    /**
+     * Redirects to use during document resolution.
+     */
+    static _redirects = [];
+    /**
+     * The document loader to use.
+     */
+    static DOCUMENT_LOADER = async (url) => JsonLdProcessor.documentLoader(url);
+    /**
+     * 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.
+     * @returns The compacted JSON-LD document.
+     */
+    static async compact(document, context) {
+        try {
+            // There is a cast here because the jsonld types are not correct.
+            // A context definition can be an array or an object, but the types only allow an object.
+            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);
+                    }
+                }
+                else if (Is.object(document)) {
+                    context = JsonLdProcessor.gatherContexts(document, context);
+                }
+            }
+            const compacted = await jsonLd.compact(document, context, {
+                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+            });
+            return compacted;
+        }
+        catch (err) {
+            if (Is.object(err) &&
+                err.name === "jsonld.InvalidUrl") {
+                throw new GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+            }
+            throw new GeneralError(JsonLdProcessor._CLASS_NAME, "compact", undefined, err);
+        }
+    }
+    /**
+     * Expand a document, removing its context.
+     * @param compacted The compacted JSON-LD document to expand.
+     * @returns The expanded JSON-LD document.
+     */
+    static async expand(compacted) {
+        try {
+            const expanded = await jsonLd.expand(compacted, {
+                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+            });
+            return expanded;
+        }
+        catch (err) {
+            if (Is.object(err) &&
+                err.name === "jsonld.InvalidUrl") {
+                throw new GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+            }
+            throw new GeneralError(JsonLdProcessor._CLASS_NAME, "expand", undefined, err);
+        }
+    }
+    /**
+     * Add a redirect to use during document resolution.
+     * @param from The URL to redirect from.
+     * @param to The URL to redirect to.
+     */
+    static addRedirect(from, to) {
+        if (!this._redirects.some(r => r.from === from)) {
+            this._redirects.push({ from, to });
+        }
+    }
     /**
      * Extract a property from the JSON-LD.
      * @param nodeObject The JSON-LD node object to extract from.
@@ -1424,7 +1514,7 @@ class JsonLdHelper {
      * @param context2 The second JSON-LD context to combine.
      * @returns The combined context.
      */
-    static async combineContexts(context1, context2) {
+    static combineContexts(context1, context2) {
         const combinedContext = [];
         if (Is.string(context1)) {
             if (!combinedContext.includes(context1)) {
@@ -1472,77 +1562,31 @@ class JsonLdHelper {
         }
         return combinedContext;
     }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * JSON-LD Processor.
- */
-class JsonLdProcessor {
     /**
-     * The class name.
-     * @internal
+     * Gather all the contexts from the element and it's children.
+     * @param element The element to gather the contexts from.
+     * @param initial The initial context.
+     * @returns The combined contexts.
      */
-    static _CLASS_NAME = "JsonLdProcessor";
-    /**
-     * Redirects to use during document resolution.
-     */
-    static _redirects = [];
-    /**
-     * The document loader to use.
-     */
-    static DOCUMENT_LOADER = async (url) => JsonLdProcessor.documentLoader(url);
-    /**
-     * 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.
-     * @returns The compacted JSON-LD document.
-     */
-    static async compact(document, context) {
-        try {
-            const compacted = await jsonLd.compact(document, context ?? {}, {
-                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
-            });
-            return compacted;
+    static gatherContexts(element, initial) {
+        let combinedContexts = initial;
+        if (!Is.empty(element["@context"])) {
+            combinedContexts = JsonLdProcessor.combineContexts(initial, element["@context"]);
         }
-        catch (err) {
-            if (Is.object(err) &&
-                err.name === "jsonld.InvalidUrl") {
-                throw new GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+        for (const prop of Object.keys(element)) {
+            const value = element[prop];
+            if (Is.object(value)) {
+                combinedContexts = this.gatherContexts(value, combinedContexts);
             }
-            throw new GeneralError(JsonLdProcessor._CLASS_NAME, "compact", undefined, err);
-        }
-    }
-    /**
-     * Expand a document, removing its context.
-     * @param compacted The compacted JSON-LD document to expand.
-     * @returns The expanded JSON-LD document.
-     */
-    static async expand(compacted) {
-        try {
-            const expanded = await jsonLd.expand(compacted, {
-                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
-            });
-            return expanded;
-        }
-        catch (err) {
-            if (Is.object(err) &&
-                err.name === "jsonld.InvalidUrl") {
-                throw new GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+            else if (Is.array(value)) {
+                for (const item of value) {
+                    if (Is.object(item)) {
+                        combinedContexts = this.gatherContexts(item, combinedContexts);
+                    }
+                }
             }
-            throw new GeneralError(JsonLdProcessor._CLASS_NAME, "expand", undefined, err);
-        }
-    }
-    /**
-     * Add a redirect to use during document resolution.
-     * @param from The URL to redirect from.
-     * @param to The URL to redirect to.
-     */
-    static addRedirect(from, to) {
-        if (!this._redirects.some(r => r.from === from)) {
-            this._redirects.push({ from, to });
         }
+        return combinedContexts;
     }
     /**
      * Document loader which uses a caching mechanism.

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

@@ -1,6 +1,6 @@
 import { type IValidationFailure } from "@twin.org/core";
 import { type ValidationMode } from "@twin.org/data-core";
-import type { IJsonLdContextDefinitionRoot, IJsonLdDocument, IJsonLdNodeObject } from "../models/IJsonLdDocument";
+import type { IJsonLdDocument } from "../models/IJsonLdDocument";
 /**
  * Class to help with JSON LD.
  */
@@ -13,19 +13,4 @@ export declare class JsonLdHelper {
      * @returns True if the document was valid.
      */
     static validate<T extends IJsonLdDocument = IJsonLdDocument>(document: T, validationFailures: IValidationFailure[], validationMode?: ValidationMode): Promise<boolean>;
-    /**
-     * Extract a property from the JSON-LD.
-     * @param nodeObject The JSON-LD node object to extract from.
-     * @param propertyNames The possible names for the property.
-     * @param deleteProperty Delete the property from the object, defaults to true.
-     * @returns The properties if available.
-     */
-    static extractProperty<T>(nodeObject: IJsonLdNodeObject, propertyNames: string[], deleteProperty?: boolean): T | undefined;
-    /**
-     * Combine contexts.
-     * @param context1 The first JSON-LD context to combine.
-     * @param context2 The second JSON-LD context to combine.
-     * @returns The combined context.
-     */
-    static combineContexts(context1: IJsonLdContextDefinitionRoot | undefined, context2: IJsonLdContextDefinitionRoot | undefined): Promise<IJsonLdContextDefinitionRoot | undefined>;
 }

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

@@ -1,5 +1,5 @@
 import type { RemoteDocument, Url } from "jsonld/jsonld-spec";
-import type { IJsonLdContextDefinition, IJsonLdDocument } from "../models/IJsonLdDocument";
+import type { IJsonLdContextDefinitionRoot, IJsonLdDocument, IJsonLdNodeObject } from "../models/IJsonLdDocument";
 /**
  * JSON-LD Processor.
  */
@@ -15,10 +15,10 @@ 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.
+     * @param context The context to compact the document to, if not provided will try and gather from the object.
      * @returns The compacted JSON-LD document.
      */
-    static compact(document: IJsonLdDocument, context?: IJsonLdContextDefinition): Promise<IJsonLdDocument>;
+    static compact(document: IJsonLdDocument, context?: IJsonLdContextDefinitionRoot): Promise<IJsonLdDocument>;
     /**
      * Expand a document, removing its context.
      * @param compacted The compacted JSON-LD document to expand.
@@ -31,4 +31,28 @@ export declare class JsonLdProcessor {
      * @param to The URL to redirect to.
      */
     static addRedirect(from: RegExp, to: string): void;
+    /**
+     * Extract a property from the JSON-LD.
+     * @param nodeObject The JSON-LD node object to extract from.
+     * @param propertyNames The possible names for the property.
+     * @param deleteProperty Delete the property from the object, defaults to true.
+     * @returns The properties if available.
+     */
+    static extractProperty<T>(nodeObject: IJsonLdNodeObject, propertyNames: string[], deleteProperty?: boolean): T | undefined;
+    /**
+     * Combine contexts.
+     * @param context1 The first JSON-LD context to combine.
+     * @param context2 The second JSON-LD context to combine.
+     * @returns The combined context.
+     */
+    static combineContexts(context1: IJsonLdContextDefinitionRoot | undefined, context2: IJsonLdContextDefinitionRoot | undefined): IJsonLdContextDefinitionRoot | undefined;
+    /**
+     * Gather all the contexts from the element and it's children.
+     * @param element The element to gather the contexts from.
+     * @param initial The initial context.
+     * @returns The combined contexts.
+     */
+    static gatherContexts(element: {
+        [id: string]: unknown;
+    }, initial?: IJsonLdContextDefinitionRoot): IJsonLdContextDefinitionRoot | undefined;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/data-json-ld - Changelog
 
-## v0.0.1-next.4
+## v0.0.1-next.5
 
 - Initial Release

package/docs/reference/classes/JsonLdHelper.md

@@ -43,59 +43,3 @@ The validation mode to use, defaults to either.
 `Promise`\<`boolean`\>
 
 True if the document was valid.
-
-***
-
-### extractProperty()
-
-> `static` **extractProperty**\<`T`\>(`nodeObject`, `propertyNames`, `deleteProperty`): `undefined` \| `T`
-
-Extract a property from the JSON-LD.
-
-#### Type Parameters
-
-• **T**
-
-#### Parameters
-
-• **nodeObject**: [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
-
-The JSON-LD node object to extract from.
-
-• **propertyNames**: `string`[]
-
-The possible names for the property.
-
-• **deleteProperty**: `boolean` = `true`
-
-Delete the property from the object, defaults to true.
-
-#### Returns
-
-`undefined` \| `T`
-
-The properties if available.
-
-***
-
-### combineContexts()
-
-> `static` **combineContexts**(`context1`, `context2`): `Promise`\<`undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)\>
-
-Combine contexts.
-
-#### Parameters
-
-• **context1**: `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
-
-The first JSON-LD context to combine.
-
-• **context2**: `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
-
-The second JSON-LD context to combine.
-
-#### Returns
-
-`Promise`\<`undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)\>
-
-The combined context.

package/docs/reference/classes/JsonLdProcessor.md

@@ -42,9 +42,9 @@ Compact a document according to a particular context.
 
 The JSON-LD document to compact.
 
-• **context?**: [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
+• **context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
 
-The context to compact the document to.
+The context to compact the document to, if not provided will try and gather from the object.
 
 #### Returns
 
@@ -93,3 +93,83 @@ The URL to redirect to.
 #### Returns
 
 `void`
+
+***
+
+### extractProperty()
+
+> `static` **extractProperty**\<`T`\>(`nodeObject`, `propertyNames`, `deleteProperty`): `undefined` \| `T`
+
+Extract a property from the JSON-LD.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **nodeObject**: [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+The JSON-LD node object to extract from.
+
+• **propertyNames**: `string`[]
+
+The possible names for the property.
+
+• **deleteProperty**: `boolean` = `true`
+
+Delete the property from the object, defaults to true.
+
+#### Returns
+
+`undefined` \| `T`
+
+The properties if available.
+
+***
+
+### combineContexts()
+
+> `static` **combineContexts**(`context1`, `context2`): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+Combine contexts.
+
+#### Parameters
+
+• **context1**: `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The first JSON-LD context to combine.
+
+• **context2**: `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The second JSON-LD context to combine.
+
+#### Returns
+
+`undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The combined context.
+
+***
+
+### gatherContexts()
+
+> `static` **gatherContexts**(`element`, `initial`?): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+Gather all the contexts from the element and it's children.
+
+#### Parameters
+
+• **element**
+
+The element to gather the contexts from.
+
+• **initial?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The initial context.
+
+#### Returns
+
+`undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The combined contexts.

package/package.json

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