@3sixty/data-json-ld 0.0.0-stage → 0.20.0-next.1

package/docs/reference/classes/JsonLdProcessor.md

@@ -0,0 +1,400 @@
+# Class: JsonLdProcessor
+
+JSON-LD Processor.
+
+## Constructors
+
+### Constructor
+
+> **new JsonLdProcessor**(): `JsonLdProcessor`
+
+#### Returns
+
+`JsonLdProcessor`
+
+## Methods
+
+### setDocumentLoader() {#setdocumentloader}
+
+> `static` **setDocumentLoader**(`documentLoader`): `void`
+
+Set the document loader used for retrieving JSON-LD documents.
+
+#### Parameters
+
+##### documentLoader
+
+(`url`) => `Promise`\<`RemoteDocument`\>
+
+The document loader to use.
+
+#### Returns
+
+`void`
+
+***
+
+### getDocumentLoader() {#getdocumentloader}
+
+> `static` **getDocumentLoader**(): (`url`) => `Promise`\<`RemoteDocument`\>
+
+Get the document loader used for retrieving JSON-LD documents.
+
+#### Returns
+
+The active document loader function.
+
+(`url`) => `Promise`\<`RemoteDocument`\>
+
+***
+
+### setCacheLimit() {#setcachelimit}
+
+> `static` **setCacheLimit**(`cacheLimitMs`): `void`
+
+Set the cache time limit for documents.
+
+#### Parameters
+
+##### cacheLimitMs
+
+`number`
+
+The cache limit in milliseconds.
+
+#### Returns
+
+`void`
+
+***
+
+### getCacheLimit() {#getcachelimit}
+
+> `static` **getCacheLimit**(): `number`
+
+Get the cache limit for documents.
+
+#### Returns
+
+`number`
+
+The cache limit in milliseconds.
+
+***
+
+### setRedirects() {#setredirects}
+
+> `static` **setRedirects**(`redirects`): `void`
+
+Replace the global redirect list (use [JsonLdProcessor.addRedirect](#addredirect) to append without replacing).
+Redirects run before any HTTP GET or `Link` discovery; use them for stable overrides, tests, or hosts that do not expose a suitable `Link` header.
+
+#### Parameters
+
+##### redirects
+
+`object`[]
+
+The redirects to use.
+
+#### Returns
+
+`void`
+
+***
+
+### getRedirects() {#getredirects}
+
+> `static` **getRedirects**(): `object`[]
+
+Get the global redirects for JSON-LD.
+
+#### Returns
+
+`object`[]
+
+The registered redirects.
+
+***
+
+### addRedirect() {#addredirect}
+
+> `static` **addRedirect**(`from`, `to`): `void`
+
+Append a redirect rule (ignored if the same `RegExp.source` is already registered).
+Optional when the vocabulary URL supports HTTP `Link` discovery (`rel` includes `alternate`, `type` is `application/ld+json`) via the default document loader.
+Standards packages often expose `registerRedirects()` helpers that call this method; those are optional for the same reason.
+
+#### Parameters
+
+##### from
+
+`RegExp`
+
+The URL to redirect from.
+
+##### to
+
+`string`
+
+The URL to redirect to.
+
+#### Returns
+
+`void`
+
+***
+
+### compact() {#compact}
+
+> `static` **compact**\<`T`\>(`document`, `context?`, `options?`): `Promise`\<`T`\>
+
+Compact a document according to a particular context.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### document
+
+`T`
+
+The JSON-LD document to compact.
+
+##### 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 options for compacting the document.
+
+###### compactArrays?
+
+`boolean`
+
+Whether to allow single-item arrays to be compacted to scalars, defaults to true (matches jsonld.js default behaviour). Set to false to preserve all single-item arrays.
+
+###### noCompactProperties?
+
+`string`[]
+
+Additional dot-notation property paths that must always remain arrays, merged with the built-in always-array set.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+The compacted JSON-LD document.
+
+***
+
+### expand() {#expand}
+
+> `static` **expand**\<`T`\>(`compacted`): `Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
+
+Expand a document, removing its context.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### compacted
+
+`T`
+
+The compacted JSON-LD document to expand.
+
+#### Returns
+
+`Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
+
+The expanded JSON-LD document.
+
+***
+
+### canonize() {#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.
+
+***
+
+### combineContexts() {#combinecontexts}
+
+> `static` **combineContexts**(`context1`, `context2`): [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+Combine contexts.
+
+#### Parameters
+
+##### context1
+
+[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+The first JSON-LD context to combine.
+
+##### context2
+
+[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+The second JSON-LD context to combine.
+
+#### Returns
+
+[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+The combined context.
+
+***
+
+### gatherContexts() {#gathercontexts}
+
+> `static` **gatherContexts**\<`T`\>(`element`, `initial?`): [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+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
+
+[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+The combined contexts.
+
+***
+
+### removeContexts() {#removecontexts}
+
+> `static` **removeContexts**(`context`, `match?`): [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+Remove all the contexts that match the pattern.
+
+#### Parameters
+
+##### context
+
+[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+The context to remove the entries from.
+
+##### match?
+
+[`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[]
+
+The element to try and match.
+
+#### Returns
+
+[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
+
+The updated contexts.
+
+***
+
+### documentCacheAdd() {#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`\>
+
+A promise that resolves when the entry has been stored in the cache.
+
+***
+
+### documentCacheRemove() {#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`\>
+
+A promise that resolves when the entry has been removed from the cache.

package/docs/reference/index.md

@@ -0,0 +1,93 @@
+# @3sixty/data-json-ld
+
+## Classes
+
+- [JsonLdDataTypes](classes/JsonLdDataTypes.md)
+- [JsonLdHelper](classes/JsonLdHelper.md)
+- [JsonLdProcessor](classes/JsonLdProcessor.md)
+
+## Interfaces
+
+- [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)
+- [IJsonLdTypeMap](interfaces/IJsonLdTypeMap.md)
+
+## Type Aliases
+
+- [JsonLdAliasKey](type-aliases/JsonLdAliasKey.md)
+- [JsonLdExistingProperty](type-aliases/JsonLdExistingProperty.md)
+- [JsonLdExistingPropertyEither](type-aliases/JsonLdExistingPropertyEither.md)
+- [JsonLdKeys](type-aliases/JsonLdKeys.md)
+- [JsonLdObjectWithAliases](type-aliases/JsonLdObjectWithAliases.md)
+- [JsonLdObjectWithAtId](type-aliases/JsonLdObjectWithAtId.md)
+- [JsonLdObjectWithAtType](type-aliases/JsonLdObjectWithAtType.md)
+- [JsonLdObjectWithContext](type-aliases/JsonLdObjectWithContext.md)
+- [JsonLdObjectWithId](type-aliases/JsonLdObjectWithId.md)
+- [JsonLdObjectWithNoAtId](type-aliases/JsonLdObjectWithNoAtId.md)
+- [JsonLdObjectWithNoAtType](type-aliases/JsonLdObjectWithNoAtType.md)
+- [JsonLdObjectWithNoContext](type-aliases/JsonLdObjectWithNoContext.md)
+- [JsonLdObjectWithNoId](type-aliases/JsonLdObjectWithNoId.md)
+- [JsonLdObjectWithNoType](type-aliases/JsonLdObjectWithNoType.md)
+- [JsonLdObjectWithOptionalAtId](type-aliases/JsonLdObjectWithOptionalAtId.md)
+- [JsonLdObjectWithOptionalAtType](type-aliases/JsonLdObjectWithOptionalAtType.md)
+- [JsonLdObjectWithOptionalContext](type-aliases/JsonLdObjectWithOptionalContext.md)
+- [JsonLdObjectWithOptionalId](type-aliases/JsonLdObjectWithOptionalId.md)
+- [JsonLdObjectWithOptionalType](type-aliases/JsonLdObjectWithOptionalType.md)
+- [JsonLdObjectWithType](type-aliases/JsonLdObjectWithType.md)
+- [JsonLdOptionalKeys](type-aliases/JsonLdOptionalKeys.md)
+- [JsonLdRequiredKeys](type-aliases/JsonLdRequiredKeys.md)
+- [JsonLdWithAliases](type-aliases/JsonLdWithAliases.md)
+- [IJsonLdContainerType](type-aliases/IJsonLdContainerType.md)
+- [IJsonLdContainerTypeArray](type-aliases/IJsonLdContainerTypeArray.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)
+- [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
+
+- [CompiledJsonLdDocument](variables/CompiledJsonLdDocument.md)
+- [CompiledJsonLdObject](variables/CompiledJsonLdObject.md)
+- [CompiledJsonLdNodeObject](variables/CompiledJsonLdNodeObject.md)
+- [CompiledJsonLdNodePrimitive](variables/CompiledJsonLdNodePrimitive.md)
+- [CompiledJsonLdGraphObject](variables/CompiledJsonLdGraphObject.md)
+- [CompiledJsonLdValueObject](variables/CompiledJsonLdValueObject.md)
+- [CompiledJsonLdListObject](variables/CompiledJsonLdListObject.md)
+- [CompiledJsonLdSetObject](variables/CompiledJsonLdSetObject.md)
+- [CompiledJsonLdLanguageMap](variables/CompiledJsonLdLanguageMap.md)
+- [CompiledJsonLdIndexMap](variables/CompiledJsonLdIndexMap.md)
+- [CompiledJsonLdIndexMapItem](variables/CompiledJsonLdIndexMapItem.md)
+- [CompiledJsonLdIdMap](variables/CompiledJsonLdIdMap.md)
+- [CompiledJsonLdTypeMap](variables/CompiledJsonLdTypeMap.md)
+- [CompiledJsonLdIncludedBlock](variables/CompiledJsonLdIncludedBlock.md)
+- [CompiledJsonLdContextDefinition](variables/CompiledJsonLdContextDefinition.md)
+- [CompiledJsonLdContextDefinitionRoot](variables/CompiledJsonLdContextDefinitionRoot.md)
+- [CompiledJsonLdContextDefinitionElement](variables/CompiledJsonLdContextDefinitionElement.md)
+- [CompiledJsonLdExpandedTermDefinition](variables/CompiledJsonLdExpandedTermDefinition.md)
+- [CompiledJsonLdListOrSetItem](variables/CompiledJsonLdListOrSetItem.md)
+- [CompiledJsonLdContainerType](variables/CompiledJsonLdContainerType.md)
+- [CompiledJsonLdContainerTypeArray](variables/CompiledJsonLdContainerTypeArray.md)
+- [CompiledJsonLdJsonPrimitive](variables/CompiledJsonLdJsonPrimitive.md)
+- [CompiledJsonLdJsonArray](variables/CompiledJsonLdJsonArray.md)
+- [CompiledJsonLdJsonObject](variables/CompiledJsonLdJsonObject.md)
+- [CompiledJsonLdJsonValue](variables/CompiledJsonLdJsonValue.md)
+- [JsonLdContexts](variables/JsonLdContexts.md)
+- [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`\]: `string` \| `boolean` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| \{ `@container`: `"@set"`; `@protected?`: `boolean`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @base? {#base}
+
+> `optional` **@base?**: `string` \| `null`
+
+***
+
+### @direction? {#direction}
+
+> `optional` **@direction?**: `"ltr"` \| `"rtl"` \| `null`
+
+***
+
+### @import? {#import}
+
+> `optional` **@import?**: `string`
+
+***
+
+### @language? {#language}
+
+> `optional` **@language?**: `string`
+
+***
+
+### @propagate? {#propagate}
+
+> `optional` **@propagate?**: `boolean`
+
+***
+
+### @protected? {#protected}
+
+> `optional` **@protected?**: `boolean`
+
+***
+
+### @type? {#type}
+
+> `optional` **@type?**: `object`
+
+#### @container
+
+> **@container**: `"@set"`
+
+#### @protected?
+
+> `optional` **@protected?**: `boolean`
+
+***
+
+### @version? {#version}
+
+> `optional` **@version?**: `"1.1"`
+
+***
+
+### @vocab? {#vocab}
+
+> `optional` **@vocab?**: `string` \| `null`

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}
+
+> **@graph**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
+
+***
+
+### @index? {#index}
+
+> `optional` **@index?**: `string`
+
+***
+
+### @id? {#id}
+
+> `optional` **@id?**: `string` \| `string`[]
+
+***
+
+### @context? {#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,7 @@
+# Interface: IJsonLdJsonObject
+
+JSON Type for object.
+
+## 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`\]: `string` \| `string`[] \| `null`

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}
+
+> **@list**: [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md)[]
+
+***
+
+### @index? {#index}
+
+> `optional` **@index?**: `string`