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

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

@@ -0,0 +1,9 @@
+# Type Alias: IJsonLdIncludedBlock
+
+> **IJsonLdIncludedBlock**: [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]
+
+An included block is used to provide a set of node objects.
+
+## See
+
+https://www.w3.org/TR/json-ld11/#included-blocks

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

@@ -0,0 +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)
+
+The items that can be stored in an index map.

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

@@ -0,0 +1,3 @@
+# Type Alias: IJsonLdJsonArray
+
+> **IJsonLdJsonArray**: [`IJsonLdJsonValue`](IJsonLdJsonValue.md)[]

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

@@ -0,0 +1,3 @@
+# Type Alias: IJsonLdJsonPrimitive
+
+> **IJsonLdJsonPrimitive**: `string` \| `number` \| `boolean` \| `null`

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

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

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

@@ -0,0 +1,105 @@
+# Type Alias: IJsonLdKeyword
+
+> **IJsonLdKeyword**: `object`
+
+A list of keywords and their types.
+Only used for internal reference; not an actual interface.
+Not for export.
+
+## Type declaration
+
+### @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

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

@@ -0,0 +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)
+
+A node primitive is a JSON-LD value which is not one of the defined NodeObject properties.

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

@@ -0,0 +1,20 @@
+# Type Alias: IJsonLdValueObject
+
+> **IJsonLdValueObject**: `object` & `object` \| `object` \| `object`
+
+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.
+
+## Type declaration
+
+### @index?
+
+> `optional` **@index**: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@index"`\]
+
+### @context?
+
+> `optional` **@context**: [`IJsonLdKeyword`](IJsonLdKeyword.md)\[`"@context"`\]
+
+## See
+
+https://www.w3.org/TR/json-ld11/#value-objects

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

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

package/docs/reference/variables/JsonLdTypes.md

@@ -0,0 +1,157 @@
+# Variable: JsonLdTypes
+
+> `const` **JsonLdTypes**: `object`
+
+The types of JSON-LD data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/json-ld/"` = `"https://schema.twindev.org/json-ld/"`
+
+Context Root.
+
+### Document
+
+> `readonly` **Document**: `"https://schema.twindev.org/json-ld/JsonLdDocument"` = `"https://schema.twindev.org/json-ld/JsonLdDocument"`
+
+Represents JSON-LD Document.
+
+### Object
+
+> `readonly` **Object**: `"https://schema.twindev.org/json-ld/JsonLdObject"` = `"https://schema.twindev.org/json-ld/JsonLdObject"`
+
+Represents JSON-LD Object.
+
+### NodeObject
+
+> `readonly` **NodeObject**: `"https://schema.twindev.org/json-ld/JsonLdNodeObject"` = `"https://schema.twindev.org/json-ld/JsonLdNodeObject"`
+
+Represents JSON-LD Node Object.
+
+### NodePrimitive
+
+> `readonly` **NodePrimitive**: `"https://schema.twindev.org/json-ld/JsonLdNodePrimitive"` = `"https://schema.twindev.org/json-ld/JsonLdNodePrimitive"`
+
+Represents JSON-LD Node Primitive.
+
+### GraphObject
+
+> `readonly` **GraphObject**: `"https://schema.twindev.org/json-ld/JsonLdGraphObject"` = `"https://schema.twindev.org/json-ld/JsonLdGraphObject"`
+
+Represents JSON-LD Graph Object.
+
+### ValueObject
+
+> `readonly` **ValueObject**: `"https://schema.twindev.org/json-ld/JsonLdValueObject"` = `"https://schema.twindev.org/json-ld/JsonLdValueObject"`
+
+Represents JSON-LD Value Object.
+
+### ListObject
+
+> `readonly` **ListObject**: `"https://schema.twindev.org/json-ld/JsonLdListObject"` = `"https://schema.twindev.org/json-ld/JsonLdListObject"`
+
+Represents JSON-LD List Object.
+
+### SetObject
+
+> `readonly` **SetObject**: `"https://schema.twindev.org/json-ld/JsonLdSetObject"` = `"https://schema.twindev.org/json-ld/JsonLdSetObject"`
+
+Represents JSON-LD Set Object.
+
+### LanguageMap
+
+> `readonly` **LanguageMap**: `"https://schema.twindev.org/json-ld/JsonLdLanguageMap"` = `"https://schema.twindev.org/json-ld/JsonLdLanguageMap"`
+
+Represents JSON-LD Language Map.
+
+### IndexMap
+
+> `readonly` **IndexMap**: `"https://schema.twindev.org/json-ld/JsonLdIndexMap"` = `"https://schema.twindev.org/json-ld/JsonLdIndexMap"`
+
+Represents JSON-LD Index Map.
+
+### IndexMapItem
+
+> `readonly` **IndexMapItem**: `"https://schema.twindev.org/json-ld/JsonLdIndexMapItem"` = `"https://schema.twindev.org/json-ld/JsonLdIndexMapItem"`
+
+Represents JSON-LD Index Map Item.
+
+### IdMap
+
+> `readonly` **IdMap**: `"https://schema.twindev.org/json-ld/JsonLdIdMap"` = `"https://schema.twindev.org/json-ld/JsonLdIdMap"`
+
+Represents JSON-LD Id Map.
+
+### TypeMap
+
+> `readonly` **TypeMap**: `"https://schema.twindev.org/json-ld/JsonLdTypeMap"` = `"https://schema.twindev.org/json-ld/JsonLdTypeMap"`
+
+Represents JSON-LD Type Map.
+
+### IncludedBlock
+
+> `readonly` **IncludedBlock**: `"https://schema.twindev.org/json-ld/JsonLdIncludedBlock"` = `"https://schema.twindev.org/json-ld/JsonLdIncludedBlock"`
+
+Represents JSON-LD Included block.
+
+### ContextDefinition
+
+> `readonly` **ContextDefinition**: `"https://schema.twindev.org/json-ld/JsonLdContextDefinition"` = `"https://schema.twindev.org/json-ld/JsonLdContextDefinition"`
+
+Represents JSON-LD Context Definition.
+
+### ExpandedTermDefinition
+
+> `readonly` **ExpandedTermDefinition**: `"https://schema.twindev.org/json-ld/JsonLdExpandedTermDefinition"` = `"https://schema.twindev.org/json-ld/JsonLdExpandedTermDefinition"`
+
+Represents JSON-LD Expanded Term Definition.
+
+### Keyword
+
+> `readonly` **Keyword**: `"https://schema.twindev.org/json-ld/JsonLdKeyword"` = `"https://schema.twindev.org/json-ld/JsonLdKeyword"`
+
+Represents JSON-LD Keyword.
+
+### ListOrSetItem
+
+> `readonly` **ListOrSetItem**: `"https://schema.twindev.org/json-ld/JsonLdListOrSetItem"` = `"https://schema.twindev.org/json-ld/JsonLdListOrSetItem"`
+
+Represents JSON-LD List or Set Item.
+
+### ContainerType
+
+> `readonly` **ContainerType**: `"https://schema.twindev.org/json-ld/JsonLdContainerType"` = `"https://schema.twindev.org/json-ld/JsonLdContainerType"`
+
+Represents JSON-LD Container Type.
+
+### ContainerTypeArray
+
+> `readonly` **ContainerTypeArray**: `"https://schema.twindev.org/json-ld/JsonLdContainerTypeArray"` = `"https://schema.twindev.org/json-ld/JsonLdContainerTypeArray"`
+
+Represents JSON-LD Container Type Array.
+
+### JsonPrimitive
+
+> `readonly` **JsonPrimitive**: `"https://schema.twindev.org/json-ld/JsonLdJsonPrimitive"` = `"https://schema.twindev.org/json-ld/JsonLdJsonPrimitive"`
+
+Represents JSON-LD JSON Primitive.
+
+### JsonArray
+
+> `readonly` **JsonArray**: `"https://schema.twindev.org/json-ld/JsonLdJsonArray"` = `"https://schema.twindev.org/json-ld/JsonLdJsonArray"`
+
+Represents JSON-LD JSON Array.
+
+### JsonObject
+
+> `readonly` **JsonObject**: `"https://schema.twindev.org/json-ld/JsonLdJsonObject"` = `"https://schema.twindev.org/json-ld/JsonLdJsonObject"`
+
+Represents JSON-LD JSON Object.
+
+### JsonValue
+
+> `readonly` **JsonValue**: `"https://schema.twindev.org/json-ld/JsonLdJsonValue"` = `"https://schema.twindev.org/json-ld/JsonLdJsonValue"`
+
+Represents JSON-LD JSON Value.

package/locales/en.json

@@ -0,0 +1,7 @@
+{
+	"jsonLdProcessor": {
+		"compact": "The JSON-LD compaction failed",
+		"expand": "The JSON-LD expansion failed",
+		"invalidUrl": "The JSON-LD processing failed to retrieve from the following url \"{url}\""
+	}
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+	"name": "@twin.org/data-json-ld",
+	"version": "0.0.1-next.10",
+	"description": "Models which define the structure of JSON LD",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/data.git",
+		"directory": "packages/data-json-ld"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/data-core": "0.0.1-next.10",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next",
+		"@types/json-schema": "7.0.15",
+		"@types/jsonld": "1.5.15",
+		"jsonld": "8.3.2"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}