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

package/docs/reference/classes/JsonLdProcessor.md

@@ -4,51 +4,167 @@ 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**: `string`
+##### documentLoader
+
+(`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**(`document`, `context`?): `Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
+> `static` **compact**\<`T`\>(`document`, `context?`, `options?`): `Promise`\<`T`\>
 
 Compact a document according to a particular context.
 
+#### Type Parameters
+
+##### T
+
+`T`
+
 #### Parameters
 
-• **document**: [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+##### document
+
+`T`
 
 The JSON-LD document to compact.
 
-• **context?**: [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
+##### context?
+
+[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The context to compact the document to, if not provided will use the one in the document.
+
+##### options?
 
-The context to compact the document to.
+The options for compacting the document.
+
+###### itemListOverride
+
+`boolean`
+
+Whether to override the itemListElement context with a set, defaults to true.
 
 #### Returns
 
-`Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
+`Promise`\<`T`\>
 
 The compacted JSON-LD document.
 
@@ -56,24 +172,70 @@ The compacted JSON-LD document.
 
 ### expand()
 
-> `static` **expand**(`compacted`): `Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
+> `static` **expand**\<`T`\>(`compacted`): `Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
 
 Expand a document, removing its context.
 
+#### Type Parameters
+
+##### T
+
+`T`
+
 #### Parameters
 
-• **compacted**: [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+##### compacted
+
+`T`
 
 The compacted JSON-LD document to expand.
 
 #### Returns
 
-`Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
+`Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
 
 The expanded JSON-LD document.
 
 ***
 
+### canonize()
+
+> `static` **canonize**\<`T`\>(`document`, `options?`): `Promise`\<`string`\>
+
+Canonize a document.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+#### Parameters
+
+##### document
+
+`T`
+
+The document to canonize.
+
+##### options?
+
+The options for canonization.
+
+###### algorithm?
+
+`"URDNA2015"` \| `"URGNA2012"`
+
+The algorithm to use for canonization, defaults to URDNA2015.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The canonized document.
+
+***
+
 ### addRedirect()
 
 > `static` **addRedirect**(`from`, `to`): `void`
@@ -82,14 +244,158 @@ Add a redirect to use during document resolution.
 
 #### Parameters
 
-• **from**: `RegExp`
+##### from
+
+`RegExp`
 
 The URL to redirect from.
 
-• **to**: `string`
+##### to
+
+`string`
 
 The URL to redirect to.
 
 #### Returns
 
 `void`
+
+***
+
+### combineContexts()
+
+> `static` **combineContexts**(`context1`, `context2`): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+Combine contexts.
+
+#### Parameters
+
+##### context1
+
+The first JSON-LD context to combine.
+
+`undefined` | [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+##### context2
+
+The second JSON-LD context to combine.
+
+`undefined` | [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+#### Returns
+
+`undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The combined context.
+
+***
+
+### gatherContexts()
+
+> `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`
+
+#### Parameters
+
+##### element
+
+`T`
+
+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.
+
+***
+
+### removeContexts()
+
+> `static` **removeContexts**(`context`, `match?`): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+Remove all the contexts that match the pattern.
+
+#### Parameters
+
+##### context
+
+The context to remove the entries from.
+
+`undefined` | [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+##### match?
+
+[`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[]
+
+The element to try and match.
+
+#### Returns
+
+`undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The updated contexts.
+
+***
+
+### documentCacheAdd()
+
+> `static` **documentCacheAdd**(`url`, `ldContext`): `Promise`\<`void`\>
+
+Add a context directly to the document loader cache.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url the ld context is for.
+
+##### ldContext
+
+`unknown`
+
+The context to add.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### documentCacheRemove()
+
+> `static` **documentCacheRemove**(`url`): `Promise`\<`void`\>
+
+Remove a context from the document loader cache.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The url the ld context is for.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/index.md

@@ -8,34 +8,39 @@
 
 ## Interfaces
 
-- [IJsonLdNodeObject](interfaces/IJsonLdNodeObject.md)
+- [IJsonLdContextDefinition](interfaces/IJsonLdContextDefinition.md)
 - [IJsonLdGraphObject](interfaces/IJsonLdGraphObject.md)
+- [IJsonLdIdMap](interfaces/IJsonLdIdMap.md)
+- [IJsonLdIndexMap](interfaces/IJsonLdIndexMap.md)
+- [IJsonLdJsonObject](interfaces/IJsonLdJsonObject.md)
+- [IJsonLdLanguageMap](interfaces/IJsonLdLanguageMap.md)
 - [IJsonLdListObject](interfaces/IJsonLdListObject.md)
+- [IJsonLdNodeObject](interfaces/IJsonLdNodeObject.md)
+- [IJsonLdObject](interfaces/IJsonLdObject.md)
 - [IJsonLdSetObject](interfaces/IJsonLdSetObject.md)
-- [IJsonLdLanguageMap](interfaces/IJsonLdLanguageMap.md)
-- [IJsonLdIndexMap](interfaces/IJsonLdIndexMap.md)
-- [IJsonLdIdMap](interfaces/IJsonLdIdMap.md)
 - [IJsonLdTypeMap](interfaces/IJsonLdTypeMap.md)
-- [IJsonLdContextDefinition](interfaces/IJsonLdContextDefinition.md)
-- [IJsonLdJsonObject](interfaces/IJsonLdJsonObject.md)
 
 ## Type Aliases
 
-- [IJsonLdDocument](type-aliases/IJsonLdDocument.md)
-- [IJsonLdNodePrimitive](type-aliases/IJsonLdNodePrimitive.md)
-- [IJsonLdValueObject](type-aliases/IJsonLdValueObject.md)
-- [IJsonLdIndexMapItem](type-aliases/IJsonLdIndexMapItem.md)
-- [IJsonLdIncludedBlock](type-aliases/IJsonLdIncludedBlock.md)
-- [IJsonLdExpandedTermDefinition](type-aliases/IJsonLdExpandedTermDefinition.md)
-- [IJsonLdKeyword](type-aliases/IJsonLdKeyword.md)
-- [IJsonLdListOrSetItem](type-aliases/IJsonLdListOrSetItem.md)
 - [IJsonLdContainerType](type-aliases/IJsonLdContainerType.md)
 - [IJsonLdContainerTypeArray](type-aliases/IJsonLdContainerTypeArray.md)
-- [IJsonLdJsonPrimitive](type-aliases/IJsonLdJsonPrimitive.md)
+- [IJsonLdContextDefinitionElement](type-aliases/IJsonLdContextDefinitionElement.md)
+- [IJsonLdContextDefinitionRoot](type-aliases/IJsonLdContextDefinitionRoot.md)
+- [IJsonLdDocument](type-aliases/IJsonLdDocument.md)
+- [IJsonLdExpandedTermDefinition](type-aliases/IJsonLdExpandedTermDefinition.md)
+- [IJsonLdIncludedBlock](type-aliases/IJsonLdIncludedBlock.md)
+- [IJsonLdIndexMapItem](type-aliases/IJsonLdIndexMapItem.md)
 - [IJsonLdJsonArray](type-aliases/IJsonLdJsonArray.md)
+- [IJsonLdJsonPrimitive](type-aliases/IJsonLdJsonPrimitive.md)
 - [IJsonLdJsonValue](type-aliases/IJsonLdJsonValue.md)
+- [IJsonLdKeyword](type-aliases/IJsonLdKeyword.md)
+- [IJsonLdListOrSetItem](type-aliases/IJsonLdListOrSetItem.md)
+- [IJsonLdNodePrimitive](type-aliases/IJsonLdNodePrimitive.md)
+- [IJsonLdValueObject](type-aliases/IJsonLdValueObject.md)
+- [JsonLdContexts](type-aliases/JsonLdContexts.md)
 - [JsonLdTypes](type-aliases/JsonLdTypes.md)
 
 ## Variables
 
+- [JsonLdContexts](variables/JsonLdContexts.md)
 - [JsonLdTypes](variables/JsonLdTypes.md)

package/docs/reference/interfaces/IJsonLdContextDefinition.md

@@ -8,7 +8,7 @@ https://www.w3.org/TR/json-ld11/#context-definitions
 
 ## Indexable
 
- \[`key`: `string`\]: `null` \| `string` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md)\[keyof [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md)\]
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `boolean` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| \{ `@container`: `"@set"`; `@protected`: `boolean`; \}
 
 ## Properties
 

package/docs/reference/interfaces/IJsonLdGraphObject.md

@@ -28,4 +28,4 @@ https://www.w3.org/TR/json-ld11/#graph-objects
 
 ### @context?
 
-> `optional` **@context**: `null` \| `string` \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| (`null` \| `string` \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md))[]
+> `optional` **@context**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)

package/docs/reference/interfaces/IJsonLdIdMap.md

@@ -8,4 +8,4 @@ https://www.w3.org/TR/json-ld11/#id-maps
 
 ## Indexable
 
- \[`key`: `string`\]: [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
+\[`key`: `string`\]: [`IJsonLdNodeObject`](IJsonLdNodeObject.md)

package/docs/reference/interfaces/IJsonLdIndexMap.md

@@ -9,4 +9,4 @@ https://www.w3.org/TR/json-ld11/#index-maps
 
 ## Indexable
 
- \[`key`: `string`\]: [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md) \| [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md)[]
+\[`key`: `string`\]: [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md) \| [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md)[]

package/docs/reference/interfaces/IJsonLdJsonObject.md

@@ -1,5 +1,7 @@
 # Interface: IJsonLdJsonObject
 
+JSON Type for object.
+
 ## Indexable
 
- \[`key`: `string`\]: [`IJsonLdJsonValue`](../type-aliases/IJsonLdJsonValue.md) \| `undefined`
+\[`key`: `string`\]: `undefined` \| [`IJsonLdJsonValue`](../type-aliases/IJsonLdJsonValue.md)

package/docs/reference/interfaces/IJsonLdLanguageMap.md

@@ -8,4 +8,4 @@ https://www.w3.org/TR/json-ld11/#language-maps
 
 ## Indexable
 
- \[`key`: `string`\]: `null` \| `string` \| `string`[]
+\[`key`: `string`\]: `null` \| `string` \| `string`[]

package/docs/reference/interfaces/IJsonLdNodeObject.md

@@ -7,15 +7,23 @@ in the graph serialized by the JSON-LD document.
 
 https://www.w3.org/TR/json-ld11/#node-objects
 
+## Extends
+
+- [`IJsonLdObject`](IJsonLdObject.md)
+
 ## Indexable
 
- \[`key`: `string`\]: [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md) \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)\[keyof [`IJsonLdNodeObject`](IJsonLdNodeObject.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
 
 ### @context?
 
-> `optional` **@context**: `null` \| `string` \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| (`null` \| `string` \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md))[]
+> `optional` **@context**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+#### Inherited from
+
+[`IJsonLdObject`](IJsonLdObject.md).[`@context`](IJsonLdObject.md#context)
 
 ***
 
@@ -23,17 +31,29 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 > `optional` **@id**: `string` \| `string`[]
 
+#### Inherited from
+
+[`IJsonLdObject`](IJsonLdObject.md).[`@id`](IJsonLdObject.md#id)
+
 ***
 
 ### @included?
 
 > `optional` **@included**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
 
+#### Inherited from
+
+[`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)
 
 ***
 
@@ -41,12 +61,20 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 > `optional` **@nest**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
 
+#### Inherited from
+
+[`IJsonLdObject`](IJsonLdObject.md).[`@nest`](IJsonLdObject.md#nest)
+
 ***
 
 ### @type?
 
 > `optional` **@type**: `string` \| `string`[]
 
+#### Inherited from
+
+[`IJsonLdObject`](IJsonLdObject.md).[`@type`](IJsonLdObject.md#type)
+
 ***
 
 ### @reverse?
@@ -55,10 +83,18 @@ https://www.w3.org/TR/json-ld11/#node-objects
 
 #### Index Signature
 
- \[`key`: `string`\]: [`IJsonLdKeyword`](../type-aliases/IJsonLdKeyword.md)\[`"@reverse"`\]
+\[`key`: `string`\]: `string`
+
+#### Inherited from
+
+[`IJsonLdObject`](IJsonLdObject.md).[`@reverse`](IJsonLdObject.md#reverse)
 
 ***
 
 ### @index?
 
 > `optional` **@index**: `string`
+
+#### Inherited from
+
+[`IJsonLdObject`](IJsonLdObject.md).[`@index`](IJsonLdObject.md#index)

package/docs/reference/interfaces/IJsonLdObject.md

@@ -0,0 +1,64 @@
+# Interface: IJsonLdObject
+
+An object represents the pre-defined properties of the node object
+in the graph serialized by the JSON-LD document.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#node-objects
+
+## Extended by
+
+- [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+***
+
+### @id?
+
+> `optional` **@id**: `string` \| `string`[]
+
+***
+
+### @included?
+
+> `optional` **@included**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
+
+***
+
+### @graph?
+
+> `optional` **@graph**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
+
+***
+
+### @nest?
+
+> `optional` **@nest**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
+
+***
+
+### @type?
+
+> `optional` **@type**: `string` \| `string`[]
+
+***
+
+### @reverse?
+
+> `optional` **@reverse**: `object`
+
+#### Index Signature
+
+\[`key`: `string`\]: `string`
+
+***
+
+### @index?
+
+> `optional` **@index**: `string`

package/docs/reference/interfaces/IJsonLdTypeMap.md

@@ -8,4 +8,4 @@ https://www.w3.org/TR/json-ld11/#type-maps
 
 ## Indexable
 
- \[`key`: `string`\]: `string` \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
+\[`key`: `string`\]: `string` \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)

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

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