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

package/dist/cjs/index.cjs

@@ -1533,13 +1533,61 @@ class JsonLdProcessor {
      */
     static _CLASS_NAME = "JsonLdProcessor";
     /**
-     * Redirects to use during document resolution.
+     * The document loader to use.
+     * @param documentLoader The document loader to use.
      */
-    static _redirects = [];
+    static setDocumentLoader(documentLoader) {
+        core.SharedStore.set("jsonLdDocumentLoader", documentLoader);
+    }
     /**
-     * The document loader to use.
+     * The document loader to use for retrieving JSON-LD documents.
+     * @returns The document loader.
+     */
+    static getDocumentLoader() {
+        let documentLoader = core.SharedStore.get("jsonLdDocumentLoader");
+        if (core.Is.empty(documentLoader)) {
+            documentLoader = async (url) => JsonLdProcessor.documentLoader(url);
+        }
+        return documentLoader;
+    }
+    /**
+     * Set the cache time limit for documents.
+     * @param cacheLimitMs The cache limit in milliseconds.
+     */
+    static setCacheLimit(cacheLimitMs) {
+        core.SharedStore.set("jsonLdDocumentCacheLimit", cacheLimitMs);
+    }
+    /**
+     * Get the cache limit for documents.
+     * @returns The document loader.
      */
-    static DOCUMENT_LOADER = async (url) => JsonLdProcessor.documentLoader(url);
+    static getCacheLimit() {
+        let cacheLimitMs = core.SharedStore.get("jsonLdDocumentCacheLimit");
+        if (core.Is.empty(cacheLimitMs)) {
+            cacheLimitMs = 3600000;
+            core.SharedStore.set("jsonLdDocumentCacheLimit", cacheLimitMs);
+        }
+        return cacheLimitMs;
+    }
+    /**
+     * Set the global redirects for JSON-LD, use addRedirect for default handling.
+     * @param redirects The redirects to use.
+     */
+    static setRedirects(redirects) {
+        core.SharedStore.set("jsonLdRedirects", redirects);
+    }
+    /**
+     * Get the global redirects for JSON-LD.
+     * @returns The registered redirects.
+     */
+    static getRedirects() {
+        let redirects = core.SharedStore.get("jsonLdRedirects");
+        if (core.Is.empty(redirects)) {
+            redirects = [];
+            core.SharedStore.set("jsonLdRedirects", redirects);
+        }
+        return redirects;
+    }
     /**
      * Compact a document according to a particular context.
      * @param document The JSON-LD document to compact.
@@ -1566,7 +1614,7 @@ class JsonLdProcessor {
                     }
                 }
                 const compacted = await jsonLd.compact(core.ObjectHelper.removeEmptyProperties(document), context, {
-                    documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+                    documentLoader: JsonLdProcessor.getDocumentLoader()
                 });
                 return compacted;
             }
@@ -1586,7 +1634,7 @@ class JsonLdProcessor {
         try {
             if (core.Is.object(compacted)) {
                 const expanded = await jsonLd.expand(core.ObjectHelper.removeEmptyProperties(compacted), {
-                    documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+                    documentLoader: JsonLdProcessor.getDocumentLoader()
                 });
                 return expanded;
             }
@@ -1609,7 +1657,7 @@ class JsonLdProcessor {
             const normalized = await jsonLd.canonize(core.ObjectHelper.removeEmptyProperties(document), {
                 algorithm: options?.algorithm ?? "URDNA2015",
                 format: "application/n-quads",
-                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+                documentLoader: JsonLdProcessor.getDocumentLoader()
             });
             return normalized;
         }
@@ -1624,8 +1672,9 @@ class JsonLdProcessor {
      * @param to The URL to redirect to.
      */
     static addRedirect(from, to) {
-        if (!this._redirects.some(r => r.from === from)) {
-            this._redirects.push({ from, to });
+        const redirects = JsonLdProcessor.getRedirects();
+        if (!redirects.some(r => r.from === from)) {
+            redirects.push({ from, to });
         }
     }
     /**
@@ -1773,7 +1822,8 @@ class JsonLdProcessor {
      * @internal
      */
     static async documentLoader(url) {
-        for (const redirect of JsonLdProcessor._redirects) {
+        const redirects = JsonLdProcessor.getRedirects();
+        for (const redirect of redirects) {
             if (redirect.from.test(url)) {
                 url = redirect.to;
                 break;
@@ -1781,7 +1831,7 @@ class JsonLdProcessor {
         }
         // Cache the results for an hour
         const response = await web.FetchHelper.fetchJson(JsonLdProcessor._CLASS_NAME, url, web.HttpMethod.GET, undefined, {
-            cacheTtlMs: 3600000,
+            cacheTtlMs: JsonLdProcessor.getCacheLimit(),
             headers: {
                 [web.HeaderTypes.Accept]: `${web.MimeTypes.JsonLd},${web.MimeTypes.Json}`
             }

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, SharedStore, ObjectHelper, GeneralError } from '@twin.org/core';
 import { FetchHelper, HttpMethod, MimeTypes, HeaderTypes } from '@twin.org/web';
 import jsonLd from 'jsonld';
 
@@ -1531,13 +1531,61 @@ class JsonLdProcessor {
      */
     static _CLASS_NAME = "JsonLdProcessor";
     /**
-     * Redirects to use during document resolution.
+     * The document loader to use.
+     * @param documentLoader The document loader to use.
      */
-    static _redirects = [];
+    static setDocumentLoader(documentLoader) {
+        SharedStore.set("jsonLdDocumentLoader", documentLoader);
+    }
     /**
-     * The document loader to use.
+     * The document loader to use for retrieving JSON-LD documents.
+     * @returns The document loader.
+     */
+    static getDocumentLoader() {
+        let documentLoader = SharedStore.get("jsonLdDocumentLoader");
+        if (Is.empty(documentLoader)) {
+            documentLoader = async (url) => JsonLdProcessor.documentLoader(url);
+        }
+        return documentLoader;
+    }
+    /**
+     * Set the cache time limit for documents.
+     * @param cacheLimitMs The cache limit in milliseconds.
+     */
+    static setCacheLimit(cacheLimitMs) {
+        SharedStore.set("jsonLdDocumentCacheLimit", cacheLimitMs);
+    }
+    /**
+     * Get the cache limit for documents.
+     * @returns The document loader.
      */
-    static DOCUMENT_LOADER = async (url) => JsonLdProcessor.documentLoader(url);
+    static getCacheLimit() {
+        let cacheLimitMs = SharedStore.get("jsonLdDocumentCacheLimit");
+        if (Is.empty(cacheLimitMs)) {
+            cacheLimitMs = 3600000;
+            SharedStore.set("jsonLdDocumentCacheLimit", cacheLimitMs);
+        }
+        return cacheLimitMs;
+    }
+    /**
+     * Set the global redirects for JSON-LD, use addRedirect for default handling.
+     * @param redirects The redirects to use.
+     */
+    static setRedirects(redirects) {
+        SharedStore.set("jsonLdRedirects", redirects);
+    }
+    /**
+     * Get the global redirects for JSON-LD.
+     * @returns The registered redirects.
+     */
+    static getRedirects() {
+        let redirects = SharedStore.get("jsonLdRedirects");
+        if (Is.empty(redirects)) {
+            redirects = [];
+            SharedStore.set("jsonLdRedirects", redirects);
+        }
+        return redirects;
+    }
     /**
      * Compact a document according to a particular context.
      * @param document The JSON-LD document to compact.
@@ -1564,7 +1612,7 @@ class JsonLdProcessor {
                     }
                 }
                 const compacted = await jsonLd.compact(ObjectHelper.removeEmptyProperties(document), context, {
-                    documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+                    documentLoader: JsonLdProcessor.getDocumentLoader()
                 });
                 return compacted;
             }
@@ -1584,7 +1632,7 @@ class JsonLdProcessor {
         try {
             if (Is.object(compacted)) {
                 const expanded = await jsonLd.expand(ObjectHelper.removeEmptyProperties(compacted), {
-                    documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+                    documentLoader: JsonLdProcessor.getDocumentLoader()
                 });
                 return expanded;
             }
@@ -1607,7 +1655,7 @@ class JsonLdProcessor {
             const normalized = await jsonLd.canonize(ObjectHelper.removeEmptyProperties(document), {
                 algorithm: options?.algorithm ?? "URDNA2015",
                 format: "application/n-quads",
-                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+                documentLoader: JsonLdProcessor.getDocumentLoader()
             });
             return normalized;
         }
@@ -1622,8 +1670,9 @@ class JsonLdProcessor {
      * @param to The URL to redirect to.
      */
     static addRedirect(from, to) {
-        if (!this._redirects.some(r => r.from === from)) {
-            this._redirects.push({ from, to });
+        const redirects = JsonLdProcessor.getRedirects();
+        if (!redirects.some(r => r.from === from)) {
+            redirects.push({ from, to });
         }
     }
     /**
@@ -1771,7 +1820,8 @@ class JsonLdProcessor {
      * @internal
      */
     static async documentLoader(url) {
-        for (const redirect of JsonLdProcessor._redirects) {
+        const redirects = JsonLdProcessor.getRedirects();
+        for (const redirect of redirects) {
             if (redirect.from.test(url)) {
                 url = redirect.to;
                 break;
@@ -1779,7 +1829,7 @@ class JsonLdProcessor {
         }
         // Cache the results for an hour
         const response = await FetchHelper.fetchJson(JsonLdProcessor._CLASS_NAME, url, HttpMethod.GET, undefined, {
-            cacheTtlMs: 3600000,
+            cacheTtlMs: JsonLdProcessor.getCacheLimit(),
             headers: {
                 [HeaderTypes.Accept]: `${MimeTypes.JsonLd},${MimeTypes.Json}`
             }

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

@@ -7,13 +7,41 @@ import type { IJsonLdNodeObject } from "../models/IJsonLdNodeObject";
  */
 export declare class JsonLdProcessor {
     /**
-     * Redirects to use during document resolution.
+     * The document loader to use.
+     * @param documentLoader The document loader to use.
      */
-    private static readonly _redirects;
+    static setDocumentLoader(documentLoader: (url: Url) => Promise<RemoteDocument>): void;
     /**
-     * The document loader to use.
+     * The document loader to use for retrieving JSON-LD documents.
+     * @returns The document loader.
+     */
+    static getDocumentLoader(): (url: Url) => Promise<RemoteDocument>;
+    /**
+     * Set the cache time limit for documents.
+     * @param cacheLimitMs The cache limit in milliseconds.
+     */
+    static setCacheLimit(cacheLimitMs: number): void;
+    /**
+     * Get the cache limit for documents.
+     * @returns The document loader.
+     */
+    static getCacheLimit(): number;
+    /**
+     * Set the global redirects for JSON-LD, use addRedirect for default handling.
+     * @param redirects The redirects to use.
+     */
+    static setRedirects(redirects: {
+        from: RegExp;
+        to: string;
+    }[]): void;
+    /**
+     * Get the global redirects for JSON-LD.
+     * @returns The registered redirects.
      */
-    static DOCUMENT_LOADER: (url: Url) => Promise<RemoteDocument>;
+    static getRedirects(): {
+        from: RegExp;
+        to: string;
+    }[];
     /**
      * Compact a document according to a particular context.
      * @param document The JSON-LD document to compact.

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/data-json-ld - Changelog
 
+## [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)
+
+
+### Features
+
+* use shared store mechanism ([#3](https://github.com/twinfoundation/data/issues/3)) ([33eb221](https://github.com/twinfoundation/data/commit/33eb221ccec2b4a79549c06e9a04225009b93a46))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.29 to 0.0.1-next.30
+
 ## [0.0.1-next.29](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.28...data-json-ld-v0.0.1-next.29) (2025-03-28)
 
 

package/docs/reference/classes/JsonLdDataTypes.md

@@ -4,13 +4,13 @@ Handle all the data types for JSON-LD.
 
 ## Constructors
 
-### new JsonLdDataTypes()
+### Constructor
 
-> **new JsonLdDataTypes**(): [`JsonLdDataTypes`](JsonLdDataTypes.md)
+> **new JsonLdDataTypes**(): `JsonLdDataTypes`
 
 #### Returns
 
-[`JsonLdDataTypes`](JsonLdDataTypes.md)
+`JsonLdDataTypes`
 
 ## Methods
 

package/docs/reference/classes/JsonLdHelper.md

@@ -4,25 +4,27 @@ Class to help with JSON LD.
 
 ## Constructors
 
-### new JsonLdHelper()
+### Constructor
 
-> **new JsonLdHelper**(): [`JsonLdHelper`](JsonLdHelper.md)
+> **new JsonLdHelper**(): `JsonLdHelper`
 
 #### Returns
 
-[`JsonLdHelper`](JsonLdHelper.md)
+`JsonLdHelper`
 
 ## Methods
 
 ### validate()
 
-> `static` **validate**\<`T`\>(`document`, `validationFailures`, `validationMode`?): `Promise`\<`boolean`\>
+> `static` **validate**\<`T`\>(`document`, `validationFailures`, `validationMode?`): `Promise`\<`boolean`\>
 
 Validate a JSON-LD document.
 
 #### Type Parameters
 
-• **T** *extends* [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md) = [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+##### T
+
+`T` *extends* [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md) = [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
 
 #### Parameters
 

package/docs/reference/classes/JsonLdProcessor.md

@@ -4,43 +4,139 @@ JSON-LD Processor.
 
 ## Constructors
 
-### new JsonLdProcessor()
+### Constructor
 
-> **new JsonLdProcessor**(): [`JsonLdProcessor`](JsonLdProcessor.md)
+> **new JsonLdProcessor**(): `JsonLdProcessor`
 
 #### Returns
 
-[`JsonLdProcessor`](JsonLdProcessor.md)
+`JsonLdProcessor`
 
 ## Methods
 
-### DOCUMENT\_LOADER()
+### setDocumentLoader()
 
-> `static` **DOCUMENT\_LOADER**(`url`): `Promise`\<`RemoteDocument`\>
+> `static` **setDocumentLoader**(`documentLoader`): `void`
 
 The document loader to use.
 
 #### Parameters
 
-##### url
+##### documentLoader
 
-`string`
+(`url`) => `Promise`\<`RemoteDocument`\>
+
+The document loader to use.
 
 #### Returns
 
+`void`
+
+***
+
+### getDocumentLoader()
+
+> `static` **getDocumentLoader**(): (`url`) => `Promise`\<`RemoteDocument`\>
+
+The document loader to use for retrieving JSON-LD documents.
+
+#### Returns
+
+The document loader.
+
+> (`url`): `Promise`\<`RemoteDocument`\>
+
+##### Parameters
+
+###### url
+
+`string`
+
+##### Returns
+
 `Promise`\<`RemoteDocument`\>
 
 ***
 
+### setCacheLimit()
+
+> `static` **setCacheLimit**(`cacheLimitMs`): `void`
+
+Set the cache time limit for documents.
+
+#### Parameters
+
+##### cacheLimitMs
+
+`number`
+
+The cache limit in milliseconds.
+
+#### Returns
+
+`void`
+
+***
+
+### getCacheLimit()
+
+> `static` **getCacheLimit**(): `number`
+
+Get the cache limit for documents.
+
+#### Returns
+
+`number`
+
+The document loader.
+
+***
+
+### setRedirects()
+
+> `static` **setRedirects**(`redirects`): `void`
+
+Set the global redirects for JSON-LD, use addRedirect for default handling.
+
+#### Parameters
+
+##### redirects
+
+`object`[]
+
+The redirects to use.
+
+#### Returns
+
+`void`
+
+***
+
+### getRedirects()
+
+> `static` **getRedirects**(): `object`[]
+
+Get the global redirects for JSON-LD.
+
+#### Returns
+
+`object`[]
+
+The registered redirects.
+
+***
+
 ### compact()
 
-> `static` **compact**\<`T`\>(`document`, `context`?): `Promise`\<`T`\>
+> `static` **compact**\<`T`\>(`document`, `context?`): `Promise`\<`T`\>
 
 Compact a document according to a particular context.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
@@ -72,7 +168,9 @@ Expand a document, removing its context.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
@@ -92,13 +190,15 @@ The expanded JSON-LD document.
 
 ### canonize()
 
-> `static` **canonize**\<`T`\>(`document`, `options`?): `Promise`\<`string`\>
+> `static` **canonize**\<`T`\>(`document`, `options?`): `Promise`\<`string`\>
 
 Canonize a document.
 
 #### Type Parameters
 
-• **T** *extends* [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+##### T
+
+`T` *extends* [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
 
 #### Parameters
 
@@ -182,13 +282,15 @@ The combined context.
 
 ### gatherContexts()
 
-> `static` **gatherContexts**\<`T`\>(`element`, `initial`?): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+> `static` **gatherContexts**\<`T`\>(`element`, `initial?`): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
 
 Gather all the contexts from the element and it's children.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
@@ -214,7 +316,7 @@ The combined contexts.
 
 ### removeContexts()
 
-> `static` **removeContexts**(`context`, `match`?): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+> `static` **removeContexts**(`context`, `match?`): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
 
 Remove all the contexts that match the pattern.
 

package/docs/reference/interfaces/IJsonLdNodeObject.md

@@ -13,7 +13,7 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 ## Indexable
 
-\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[] \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdListObject`](IJsonLdListObject.md) \| `object` & `object` \| `object` & `object` \| `object` & `object` \| [`IJsonLdSetObject`](IJsonLdSetObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdGraphObject`](IJsonLdGraphObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[] \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[] \| \{\} \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[]
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[] \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| `IJsonLdNodeObject` \| [`IJsonLdListObject`](IJsonLdListObject.md) \| `object` & `object` \| `object` & `object` \| `object` & `object` \| [`IJsonLdSetObject`](IJsonLdSetObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdGraphObject`](IJsonLdGraphObject.md) \| `IJsonLdNodeObject`[] \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[] \| \{[`key`: `string`]: `string`; \} \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[]
 
 ## Properties
 
@@ -23,7 +23,7 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 #### Inherited from
 
-[`IJsonLdObject`](IJsonLdObject.md).[`@context`](IJsonLdObject.md#@context)
+[`IJsonLdObject`](IJsonLdObject.md).[`@context`](IJsonLdObject.md#context)
 
 ***
 
@@ -33,7 +33,7 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 #### Inherited from
 
-[`IJsonLdObject`](IJsonLdObject.md).[`@id`](IJsonLdObject.md#@id)
+[`IJsonLdObject`](IJsonLdObject.md).[`@id`](IJsonLdObject.md#id)
 
 ***
 
@@ -43,17 +43,17 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 #### Inherited from
 
-[`IJsonLdObject`](IJsonLdObject.md).[`@included`](IJsonLdObject.md#@included)
+[`IJsonLdObject`](IJsonLdObject.md).[`@included`](IJsonLdObject.md#included)
 
 ***
 
 ### @graph?
 
-> `optional` **@graph**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
+> `optional` **@graph**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
 
 #### Inherited from
 
-[`IJsonLdObject`](IJsonLdObject.md).[`@graph`](IJsonLdObject.md#@graph)
+[`IJsonLdObject`](IJsonLdObject.md).[`@graph`](IJsonLdObject.md#graph)
 
 ***
 
@@ -63,7 +63,7 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 #### Inherited from
 
-[`IJsonLdObject`](IJsonLdObject.md).[`@nest`](IJsonLdObject.md#@nest)
+[`IJsonLdObject`](IJsonLdObject.md).[`@nest`](IJsonLdObject.md#nest)
 
 ***
 
@@ -73,7 +73,7 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 #### Inherited from
 
-[`IJsonLdObject`](IJsonLdObject.md).[`@type`](IJsonLdObject.md#@type)
+[`IJsonLdObject`](IJsonLdObject.md).[`@type`](IJsonLdObject.md#type)
 
 ***
 
@@ -87,7 +87,7 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 #### Inherited from
 
-[`IJsonLdObject`](IJsonLdObject.md).[`@reverse`](IJsonLdObject.md#@reverse)
+[`IJsonLdObject`](IJsonLdObject.md).[`@reverse`](IJsonLdObject.md#reverse)
 
 ***
 
@@ -97,4 +97,4 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 #### Inherited from
 
-[`IJsonLdObject`](IJsonLdObject.md).[`@index`](IJsonLdObject.md#@index)
+[`IJsonLdObject`](IJsonLdObject.md).[`@index`](IJsonLdObject.md#index)

package/docs/reference/type-aliases/IJsonLdContainerType.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdContainerType
 
-> **IJsonLdContainerType**: `"@language"` \| `"@index"` \| `"@id"` \| `"@graph"` \| `"@type"`
+> **IJsonLdContainerType** = `"@language"` \| `"@index"` \| `"@id"` \| `"@graph"` \| `"@type"`
 
 Helper Types

package/docs/reference/type-aliases/IJsonLdContainerTypeArray.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdContainerTypeArray
 
-> **IJsonLdContainerTypeArray**: \[`"@graph"`, `"@id"`\] \| \[`"@id"`, `"@graph"`\] \| \[`"@set"`, `"@graph"`, `"@id"`\] \| \[`"@set"`, `"@id"`, `"@graph"`\] \| \[`"@graph"`, `"@set"`, `"@id"`\] \| \[`"@id"`, `"@set"`, `"@graph"`\] \| \[`"@graph"`, `"@id"`, `"@set"`\] \| \[`"@id"`, `"@graph"`, `"@set"`\] \| \[`"@set"`, [`IJsonLdContainerType`](IJsonLdContainerType.md)\] \| \[[`IJsonLdContainerType`](IJsonLdContainerType.md), `"@set"`\]
+> **IJsonLdContainerTypeArray** = \[`"@graph"`, `"@id"`\] \| \[`"@id"`, `"@graph"`\] \| \[`"@set"`, `"@graph"`, `"@id"`\] \| \[`"@set"`, `"@id"`, `"@graph"`\] \| \[`"@graph"`, `"@set"`, `"@id"`\] \| \[`"@id"`, `"@set"`, `"@graph"`\] \| \[`"@graph"`, `"@id"`, `"@set"`\] \| \[`"@id"`, `"@graph"`, `"@set"`\] \| \[`"@set"`, [`IJsonLdContainerType`](IJsonLdContainerType.md)\] \| \[[`IJsonLdContainerType`](IJsonLdContainerType.md), `"@set"`\]
 
 Helper Types.

package/docs/reference/type-aliases/IJsonLdContextDefinitionElement.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdContextDefinitionElement
 
-> **IJsonLdContextDefinitionElement**: `null` \| `string` \| [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
+> **IJsonLdContextDefinitionElement** = `null` \| `string` \| [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
 
 A context definition element is used to define the types of a context definition.

package/docs/reference/type-aliases/IJsonLdContextDefinitionRoot.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdContextDefinitionRoot
 
-> **IJsonLdContextDefinitionRoot**: [`IJsonLdContextDefinitionElement`](IJsonLdContextDefinitionElement.md) \| [`IJsonLdContextDefinitionElement`](IJsonLdContextDefinitionElement.md)[]
+> **IJsonLdContextDefinitionRoot** = [`IJsonLdContextDefinitionElement`](IJsonLdContextDefinitionElement.md) \| [`IJsonLdContextDefinitionElement`](IJsonLdContextDefinitionElement.md)[]
 
 A context definition root is used to define the root of a context definition.

package/docs/reference/type-aliases/IJsonLdDocument.md

@@ -1,6 +1,6 @@
 # Type Alias: IJsonLdDocument
 
-> **IJsonLdDocument**: [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[] \| \{ `@context`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@context"`\]; `@graph`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@graph"`\]; \}
+> **IJsonLdDocument** = [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[] \| \{ `@context`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@context"`\]; `@graph`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@graph"`\]; \}
 
 A JSON-LD document MUST be valid JSON text as described in [RFC8259],
 or some format that can be represented in the JSON-LD internal representation

package/docs/reference/type-aliases/IJsonLdExpandedTermDefinition.md

@@ -1,6 +1,6 @@
 # Type Alias: IJsonLdExpandedTermDefinition
 
-> **IJsonLdExpandedTermDefinition**: `object` & \{ `@id`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@id"`\] \| `null`; `@nest`: `"@nest"` \| `string`; `@container`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@container"`\]; \} \| \{ `@reverse`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@reverse"`\]; `@container`: `"@set"` \| `"@index"` \| `null`; \}
+> **IJsonLdExpandedTermDefinition** = `object` & \{ `@id`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@id"`\] \| `null`; `@nest`: `"@nest"` \| `string`; `@container`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@container"`\]; \} \| \{ `@reverse`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@reverse"`\]; `@container`: `"@set"` \| `"@index"` \| `null`; \}
 
 An expanded term definition is used to describe the mapping between a term
 and its expanded identifier, as well as other properties of the value

package/docs/reference/type-aliases/IJsonLdIncludedBlock.md

@@ -1,6 +1,6 @@
 # Type Alias: IJsonLdIncludedBlock
 
-> **IJsonLdIncludedBlock**: [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]
+> **IJsonLdIncludedBlock** = [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]
 
 An included block is used to provide a set of node objects.
 

package/docs/reference/type-aliases/IJsonLdIndexMapItem.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdIndexMapItem
 
-> **IJsonLdIndexMapItem**: `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdListObject`](../interfaces/IJsonLdListObject.md) \| [`IJsonLdSetObject`](../interfaces/IJsonLdSetObject.md)
+> **IJsonLdIndexMapItem** = `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdListObject`](../interfaces/IJsonLdListObject.md) \| [`IJsonLdSetObject`](../interfaces/IJsonLdSetObject.md)
 
 The items that can be stored in an index map.

package/docs/reference/type-aliases/IJsonLdJsonArray.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdJsonArray
 
-> **IJsonLdJsonArray**: [`IJsonLdJsonValue`](IJsonLdJsonValue.md)[]
+> **IJsonLdJsonArray** = [`IJsonLdJsonValue`](IJsonLdJsonValue.md)[]
 
 JSON Type for array.

package/docs/reference/type-aliases/IJsonLdJsonPrimitive.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdJsonPrimitive
 
-> **IJsonLdJsonPrimitive**: `string` \| `number` \| `boolean` \| `null`
+> **IJsonLdJsonPrimitive** = `string` \| `number` \| `boolean` \| `null`
 
 JSON Primitive.

package/docs/reference/type-aliases/IJsonLdJsonValue.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdJsonValue
 
-> **IJsonLdJsonValue**: [`IJsonLdJsonPrimitive`](IJsonLdJsonPrimitive.md) \| [`IJsonLdJsonArray`](IJsonLdJsonArray.md) \| [`IJsonLdJsonObject`](../interfaces/IJsonLdJsonObject.md)
+> **IJsonLdJsonValue** = [`IJsonLdJsonPrimitive`](IJsonLdJsonPrimitive.md) \| [`IJsonLdJsonArray`](IJsonLdJsonArray.md) \| [`IJsonLdJsonObject`](../interfaces/IJsonLdJsonObject.md)
 
 JSON Value.

package/docs/reference/type-aliases/IJsonLdKeyword.md

@@ -1,105 +1,149 @@
 # Type Alias: IJsonLdKeyword
 
-> **IJsonLdKeyword**: `object`
+> **IJsonLdKeyword** = `object`
 
 A list of keywords and their types.
 Only used for internal reference; not an actual interface.
 Not for export.
 
-## Type declaration
+## See
+
+https://www.w3.org/TR/json-ld/#keywords
+
+## Properties
 
 ### @base
 
 > **@base**: `string` \| `null`
 
+***
+
 ### @container
 
 > **@container**: `"@list"` \| `"@set"` \| [`IJsonLdContainerType`](IJsonLdContainerType.md) \| (`"@list"` \| `"@set"` \| [`IJsonLdContainerType`](IJsonLdContainerType.md))[] \| [`IJsonLdContainerTypeArray`](IJsonLdContainerTypeArray.md) \| `null`
 
+***
+
 ### @context
 
 > **@context**: [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md)
 
+***
+
 ### @direction
 
 > **@direction**: `"ltr"` \| `"rtl"` \| `null`
 
+***
+
 ### @graph
 
 > **@graph**: [`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| ([`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md))[]
 
+***
+
 ### @id
 
 > **@id**: `string` \| `string`[]
 
+***
+
 ### @import
 
 > **@import**: `string`
 
+***
+
 ### @included
 
 > **@included**: [`IJsonLdIncludedBlock`](IJsonLdIncludedBlock.md)
 
+***
+
 ### @index
 
 > **@index**: `string`
 
+***
+
 ### @json
 
 > **@json**: `"@json"`
 
+***
+
 ### @language
 
 > **@language**: `string`
 
+***
+
 ### @list
 
 > **@list**: [`IJsonLdListOrSetItem`](IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](IJsonLdListOrSetItem.md)[]
 
+***
+
 ### @nest
 
 > **@nest**: `object`
 
+***
+
 ### @none
 
 > **@none**: `"@none"`
 
+***
+
 ### @prefix
 
 > **@prefix**: `boolean`
 
+***
+
 ### @propagate
 
 > **@propagate**: `boolean`
 
+***
+
 ### @protected
 
 > **@protected**: `boolean`
 
+***
+
 ### @reverse
 
 > **@reverse**: `string`
 
+***
+
 ### @set
 
 > **@set**: [`IJsonLdListOrSetItem`](IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](IJsonLdListOrSetItem.md)[]
 
+***
+
 ### @type
 
 > **@type**: `string`
 
+***
+
 ### @value
 
 > **@value**: `null` \| `boolean` \| `number` \| `string`
 
+***
+
 ### @version
 
 > **@version**: `"1.1"`
 
+***
+
 ### @vocab
 
 > **@vocab**: `string` \| `null`
-
-## See
-
-https://www.w3.org/TR/json-ld/#keywords

package/docs/reference/type-aliases/IJsonLdListOrSetItem.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdListOrSetItem
 
-> **IJsonLdListOrSetItem**: `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md)
+> **IJsonLdListOrSetItem** = `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md)
 
 A list or set item can be a null, boolean, number, string, node object, or value object.

package/docs/reference/type-aliases/IJsonLdNodePrimitive.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonLdNodePrimitive
 
-> **IJsonLdNodePrimitive**: `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdGraphObject`](../interfaces/IJsonLdGraphObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdListObject`](../interfaces/IJsonLdListObject.md) \| [`IJsonLdSetObject`](../interfaces/IJsonLdSetObject.md)
+> **IJsonLdNodePrimitive** = `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdGraphObject`](../interfaces/IJsonLdGraphObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdListObject`](../interfaces/IJsonLdListObject.md) \| [`IJsonLdSetObject`](../interfaces/IJsonLdSetObject.md)
 
 A node primitive is a JSON-LD value which is not one of the defined NodeObject properties.

package/docs/reference/type-aliases/IJsonLdValueObject.md

@@ -1,6 +1,6 @@
 # Type Alias: IJsonLdValueObject
 
-> **IJsonLdValueObject**: `object` & \{ `@value`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@value"`\]; `@language`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@language"`\]; `@direction`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@direction"`\]; \} \| \{ `@value`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@value"`\]; `@type`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@type"`\]; \} \| \{ `@value`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@value"`\] \| [`IJsonLdJsonObject`](../interfaces/IJsonLdJsonObject.md) \| [`IJsonLdJsonArray`](IJsonLdJsonArray.md); `@type`: `"@json"`; \}
+> **IJsonLdValueObject** = `object` & \{ `@value`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@value"`\]; `@language`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@language"`\]; `@direction`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@direction"`\]; \} \| \{ `@value`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@value"`\]; `@type`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@type"`\]; \} \| \{ `@value`: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@value"`\] \| [`IJsonLdJsonObject`](../interfaces/IJsonLdJsonObject.md) \| [`IJsonLdJsonArray`](IJsonLdJsonArray.md); `@type`: `"@json"`; \}
 
 A value object is used to explicitly associate a type or a language with a value
 to create a typed value or a language-tagged string and possibly associate a base direction.

package/docs/reference/type-aliases/JsonLdContexts.md

@@ -1,5 +1,5 @@
 # Type Alias: JsonLdContexts
 
-> **JsonLdContexts**: *typeof* [`JsonLdContexts`](../variables/JsonLdContexts.md)\[keyof *typeof* [`JsonLdContexts`](../variables/JsonLdContexts.md)\]
+> **JsonLdContexts** = *typeof* [`JsonLdContexts`](../variables/JsonLdContexts.md)\[keyof *typeof* [`JsonLdContexts`](../variables/JsonLdContexts.md)\]
 
 The contexts of JSON-LD data.

package/docs/reference/type-aliases/JsonLdTypes.md

@@ -1,5 +1,5 @@
 # Type Alias: JsonLdTypes
 
-> **JsonLdTypes**: *typeof* [`JsonLdTypes`](../variables/JsonLdTypes.md)\[keyof *typeof* [`JsonLdTypes`](../variables/JsonLdTypes.md)\]
+> **JsonLdTypes** = *typeof* [`JsonLdTypes`](../variables/JsonLdTypes.md)\[keyof *typeof* [`JsonLdTypes`](../variables/JsonLdTypes.md)\]
 
 The types of JSON-LD data.

package/package.json

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