@twin.org/data-json-ld 0.0.1-next.10

package/docs/reference/classes/JsonLdProcessor.md

@@ -0,0 +1,199 @@
+# Class: JsonLdProcessor
+
+JSON-LD Processor.
+
+## Constructors
+
+### new JsonLdProcessor()
+
+> **new JsonLdProcessor**(): [`JsonLdProcessor`](JsonLdProcessor.md)
+
+#### Returns
+
+[`JsonLdProcessor`](JsonLdProcessor.md)
+
+## Methods
+
+### DOCUMENT\_LOADER()
+
+> `static` **DOCUMENT\_LOADER**(`url`): `Promise`\<`RemoteDocument`\>
+
+The document loader to use.
+
+#### Parameters
+
+• **url**: `string`
+
+#### Returns
+
+`Promise`\<`RemoteDocument`\>
+
+***
+
+### compact()
+
+> `static` **compact**(`document`, `context`?): `Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
+
+Compact a document according to a particular context.
+
+#### Parameters
+
+• **document**: [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+
+The JSON-LD document to compact.
+
+• **context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The context to compact the document to, if not provided will try and gather from the object.
+
+#### Returns
+
+`Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
+
+The compacted JSON-LD document.
+
+***
+
+### expand()
+
+> `static` **expand**(`compacted`): `Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
+
+Expand a document, removing its context.
+
+#### Parameters
+
+• **compacted**: [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+
+The compacted JSON-LD document to expand.
+
+#### Returns
+
+`Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
+
+The expanded JSON-LD document.
+
+***
+
+### addRedirect()
+
+> `static` **addRedirect**(`from`, `to`): `void`
+
+Add a redirect to use during document resolution.
+
+#### Parameters
+
+• **from**: `RegExp`
+
+The URL to redirect from.
+
+• **to**: `string`
+
+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.
+
+***
+
+### removeContexts()
+
+> `static` **removeContexts**(`context`, `match`?): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+Remove all the contexts that match the pattern.
+
+#### Parameters
+
+• **context**: `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The context to remove the entries from.
+
+• **match?**: [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[]
+
+The element to try and match.
+
+#### Returns
+
+`undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The updated contexts.

package/docs/reference/index.md

@@ -0,0 +1,44 @@
+# @twin.org/data-json-ld
+
+## Classes
+
+- [JsonLdDataTypes](classes/JsonLdDataTypes.md)
+- [JsonLdHelper](classes/JsonLdHelper.md)
+- [JsonLdProcessor](classes/JsonLdProcessor.md)
+
+## Interfaces
+
+- [IJsonLdNodeObject](interfaces/IJsonLdNodeObject.md)
+- [IJsonLdObject](interfaces/IJsonLdObject.md)
+- [IJsonLdGraphObject](interfaces/IJsonLdGraphObject.md)
+- [IJsonLdListObject](interfaces/IJsonLdListObject.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)
+- [IJsonLdContextDefinitionElement](type-aliases/IJsonLdContextDefinitionElement.md)
+- [IJsonLdContextDefinitionRoot](type-aliases/IJsonLdContextDefinitionRoot.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)
+- [IJsonLdJsonArray](type-aliases/IJsonLdJsonArray.md)
+- [IJsonLdJsonValue](type-aliases/IJsonLdJsonValue.md)
+- [JsonLdTypes](type-aliases/JsonLdTypes.md)
+
+## Variables
+
+- [JsonLdTypes](variables/JsonLdTypes.md)

package/docs/reference/interfaces/IJsonLdContextDefinition.md

@@ -0,0 +1,73 @@
+# Interface: IJsonLdContextDefinition
+
+A context definition defines a local context in a node object.
+
+## See
+
+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)\]
+
+## Properties
+
+### @base?
+
+> `optional` **@base**: `null` \| `string`
+
+***
+
+### @direction?
+
+> `optional` **@direction**: `null` \| `"ltr"` \| `"rtl"`
+
+***
+
+### @import?
+
+> `optional` **@import**: `string`
+
+***
+
+### @language?
+
+> `optional` **@language**: `string`
+
+***
+
+### @propagate?
+
+> `optional` **@propagate**: `boolean`
+
+***
+
+### @protected?
+
+> `optional` **@protected**: `boolean`
+
+***
+
+### @type?
+
+> `optional` **@type**: `object`
+
+#### @container
+
+> **@container**: `"@set"`
+
+#### @protected?
+
+> `optional` **@protected**: `boolean`
+
+***
+
+### @version?
+
+> `optional` **@version**: `"1.1"`
+
+***
+
+### @vocab?
+
+> `optional` **@vocab**: `null` \| `string`

package/docs/reference/interfaces/IJsonLdGraphObject.md

@@ -0,0 +1,31 @@
+# Interface: IJsonLdGraphObject
+
+A graph object represents a named graph, which MAY include an explicit graph name.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#graph-objects
+
+## Properties
+
+### @graph
+
+> **@graph**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
+
+***
+
+### @index?
+
+> `optional` **@index**: `string`
+
+***
+
+### @id?
+
+> `optional` **@id**: `string` \| `string`[]
+
+***
+
+### @context?
+
+> `optional` **@context**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)

package/docs/reference/interfaces/IJsonLdIdMap.md

@@ -0,0 +1,11 @@
+# Interface: IJsonLdIdMap
+
+An id map is used to associate an IRI with a value that allows easy programmatic access.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#id-maps
+
+## Indexable
+
+ \[`key`: `string`\]: [`IJsonLdNodeObject`](IJsonLdNodeObject.md)

package/docs/reference/interfaces/IJsonLdIndexMap.md

@@ -0,0 +1,12 @@
+# Interface: IJsonLdIndexMap
+
+An index map allows keys that have no semantic meaning, but should be preserved regardless,
+to be used in JSON-LD documents.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#index-maps
+
+## Indexable
+
+ \[`key`: `string`\]: [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md) \| [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md)[]

package/docs/reference/interfaces/IJsonLdJsonObject.md

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

package/docs/reference/interfaces/IJsonLdLanguageMap.md

@@ -0,0 +1,11 @@
+# Interface: IJsonLdLanguageMap
+
+A language map is used to associate a language with a value in a way that allows easy programmatic access.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#language-maps
+
+## Indexable
+
+ \[`key`: `string`\]: `null` \| `string` \| `string`[]

package/docs/reference/interfaces/IJsonLdListObject.md

@@ -0,0 +1,19 @@
+# Interface: IJsonLdListObject
+
+A list represents an ordered set of values.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#lists-and-sets
+
+## Properties
+
+### @list
+
+> **@list**: [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md)[]
+
+***
+
+### @index?
+
+> `optional` **@index**: `string`

package/docs/reference/interfaces/IJsonLdNodeObject.md

@@ -0,0 +1,100 @@
+# Interface: IJsonLdNodeObject
+
+A node object represents zero or more properties of a node
+in the graph serialized by the JSON-LD document.
+
+## See
+
+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)\]
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+#### Inherited from
+
+[`IJsonLdObject`](IJsonLdObject.md).[`@context`](IJsonLdObject.md#@context)
+
+***
+
+### @id?
+
+> `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)[]
+
+#### Inherited from
+
+[`IJsonLdObject`](IJsonLdObject.md).[`@graph`](IJsonLdObject.md#@graph)
+
+***
+
+### @nest?
+
+> `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?
+
+> `optional` **@reverse**: `object`
+
+#### Index Signature
+
+ \[`key`: `string`\]: [`IJsonLdKeyword`](../type-aliases/IJsonLdKeyword.md)\[`"@reverse"`\]
+
+#### 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`\]: [`IJsonLdKeyword`](../type-aliases/IJsonLdKeyword.md)\[`"@reverse"`\]
+
+***
+
+### @index?
+
+> `optional` **@index**: `string`

package/docs/reference/interfaces/IJsonLdSetObject.md

@@ -0,0 +1,19 @@
+# Interface: IJsonLdSetObject
+
+A set represents an unordered set of values.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#lists-and-sets
+
+## Properties
+
+### @set
+
+> **@set**: [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md)[]
+
+***
+
+### @index?
+
+> `optional` **@index**: `string`

package/docs/reference/interfaces/IJsonLdTypeMap.md

@@ -0,0 +1,11 @@
+# Interface: IJsonLdTypeMap
+
+A type map is used to associate an IRI with a value that allows easy programmatic access.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#type-maps
+
+## Indexable
+
+ \[`key`: `string`\]: `string` \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)

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

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

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

@@ -0,0 +1,3 @@
+# 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"`]

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

@@ -0,0 +1,5 @@
+# Type Alias: IJsonLdContextDefinitionElement
+
+> **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

@@ -0,0 +1,5 @@
+# Type Alias: IJsonLdContextDefinitionRoot
+
+> **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

@@ -0,0 +1,11 @@
+# Type Alias: IJsonLdDocument
+
+> **IJsonLdDocument**: [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[] \| `object`
+
+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
+that is equivalent to valid JSON text.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#json-ld-grammar

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

@@ -0,0 +1,41 @@
+# Type Alias: IJsonLdExpandedTermDefinition
+
+> **IJsonLdExpandedTermDefinition**: `object` & `object` \| `object`
+
+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
+associated with the term when it is used as key in a node object.
+
+## Type declaration
+
+### @type?
+
+> `optional` **@type**: `"@id"` \| `"@json"` \| `"@none"` \| `"@vocab"` \| `string`
+
+### @language?
+
+> `optional` **@language**: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@language"`\]
+
+### @index?
+
+> `optional` **@index**: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@index"`\]
+
+### @context?
+
+> `optional` **@context**: [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
+
+### @prefix?
+
+> `optional` **@prefix**: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@prefix"`\]
+
+### @propagate?
+
+> `optional` **@propagate**: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@propagate"`\]
+
+### @protected?
+
+> `optional` **@protected**: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@protected"`\]
+
+## See
+
+https://www.w3.org/TR/json-ld11/#expanded-term-definition