@twin.org/data-json-ld 0.0.3-next.2 → 0.0.3-next.20

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

@@ -0,0 +1,11 @@
+# Type Alias: JsonLdRequiredKeys\<T\>
+
+> **JsonLdRequiredKeys**\<`T`\> = `Exclude`\<keyof `T`, [`JsonLdOptionalKeys`](JsonLdOptionalKeys.md)\<`T`\>\>
+
+Extract the required property names from a type.
+
+## Type Parameters
+
+### T
+
+`T`

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

@@ -0,0 +1,17 @@
+# Type Alias: JsonLdWithAliases\<T, Prefix\>
+
+> **JsonLdWithAliases**\<`T`, `Prefix`\> = `{ [K in Extract<JsonLdRequiredKeys<T>, string> as JsonLdAliasKey<K, Prefix>]: T[K] }` & `{ [K in Extract<JsonLdOptionalKeys<T>, string> as JsonLdAliasKey<K, Prefix>]?: T[K] }`
+
+Remap an object type so JSON-LD keys ("@...") are preserved and
+non-JSON-LD keys are exposed as `Prefix:key` aliases, while preserving
+each key's original required/optional status.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### Prefix
+
+`Prefix` *extends* `string`

package/docs/reference/variables/JsonLdContexts.md

@@ -6,8 +6,20 @@ The contexts of JSON-LD data.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace {#namespace}
 
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/json-ld/"` = `"https://schema.twindev.org/json-ld/"`
+> `readonly` **Namespace**: `"https://schema.twindev.org/json-ld/"` = `"https://schema.twindev.org/json-ld/"`
 
-Context Root.
+The canonical RDF namespace URI for JSON-LD.
+
+### Context {#context}
+
+> `readonly` **Context**: `"https://schema.twindev.org/json-ld/"` = `"https://schema.twindev.org/json-ld/"`
+
+The value to use in JSON-LD context for JSON-LD.
+
+### JsonLdContext {#jsonldcontext}
+
+> `readonly` **JsonLdContext**: `"https://schema.twindev.org/json-ld/types.jsonld"` = `"https://schema.twindev.org/json-ld/types.jsonld"`
+
+The JSON-LD Context URL for JSON-LD.

package/docs/reference/variables/JsonLdTypes.md

@@ -6,157 +6,157 @@ The types of JSON-LD data.
 
 ## Type Declaration
 
-### Document
+### Document {#document}
 
 > `readonly` **Document**: `"JsonLdDocument"` = `"JsonLdDocument"`
 
 Represents JSON-LD Document.
 
-### Object
+### Object {#object}
 
 > `readonly` **Object**: `"JsonLdObject"` = `"JsonLdObject"`
 
 Represents JSON-LD Object.
 
-### NodeObject
+### NodeObject {#nodeobject}
 
 > `readonly` **NodeObject**: `"JsonLdNodeObject"` = `"JsonLdNodeObject"`
 
 Represents JSON-LD Node Object.
 
-### NodePrimitive
+### NodePrimitive {#nodeprimitive}
 
 > `readonly` **NodePrimitive**: `"JsonLdNodePrimitive"` = `"JsonLdNodePrimitive"`
 
 Represents JSON-LD Node Primitive.
 
-### GraphObject
+### GraphObject {#graphobject}
 
 > `readonly` **GraphObject**: `"JsonLdGraphObject"` = `"JsonLdGraphObject"`
 
 Represents JSON-LD Graph Object.
 
-### ValueObject
+### ValueObject {#valueobject}
 
 > `readonly` **ValueObject**: `"JsonLdValueObject"` = `"JsonLdValueObject"`
 
 Represents JSON-LD Value Object.
 
-### ListObject
+### ListObject {#listobject}
 
 > `readonly` **ListObject**: `"JsonLdListObject"` = `"JsonLdListObject"`
 
 Represents JSON-LD List Object.
 
-### SetObject
+### SetObject {#setobject}
 
 > `readonly` **SetObject**: `"JsonLdSetObject"` = `"JsonLdSetObject"`
 
 Represents JSON-LD Set Object.
 
-### LanguageMap
+### LanguageMap {#languagemap}
 
 > `readonly` **LanguageMap**: `"JsonLdLanguageMap"` = `"JsonLdLanguageMap"`
 
 Represents JSON-LD Language Map.
 
-### IndexMap
+### IndexMap {#indexmap}
 
 > `readonly` **IndexMap**: `"JsonLdIndexMap"` = `"JsonLdIndexMap"`
 
 Represents JSON-LD Index Map.
 
-### IndexMapItem
+### IndexMapItem {#indexmapitem}
 
 > `readonly` **IndexMapItem**: `"JsonLdIndexMapItem"` = `"JsonLdIndexMapItem"`
 
 Represents JSON-LD Index Map Item.
 
-### IdMap
+### IdMap {#idmap}
 
 > `readonly` **IdMap**: `"JsonLdIdMap"` = `"JsonLdIdMap"`
 
 Represents JSON-LD Id Map.
 
-### TypeMap
+### TypeMap {#typemap}
 
 > `readonly` **TypeMap**: `"JsonLdTypeMap"` = `"JsonLdTypeMap"`
 
 Represents JSON-LD Type Map.
 
-### IncludedBlock
+### IncludedBlock {#includedblock}
 
 > `readonly` **IncludedBlock**: `"JsonLdIncludedBlock"` = `"JsonLdIncludedBlock"`
 
 Represents JSON-LD Included block.
 
-### ContextDefinition
+### ContextDefinition {#contextdefinition}
 
 > `readonly` **ContextDefinition**: `"JsonLdContextDefinition"` = `"JsonLdContextDefinition"`
 
 Represents JSON-LD Context Definition.
 
-### ContextDefinitionElement
+### ContextDefinitionElement {#contextdefinitionelement}
 
 > `readonly` **ContextDefinitionElement**: `"JsonLdContextDefinitionElement"` = `"JsonLdContextDefinitionElement"`
 
 Represents JSON-LD Context Definition Element.
 
-### ContextDefinitionRoot
+### ContextDefinitionRoot {#contextdefinitionroot}
 
 > `readonly` **ContextDefinitionRoot**: `"JsonLdContextDefinitionRoot"` = `"JsonLdContextDefinitionRoot"`
 
 Represents JSON-LD Context Definition Root.
 
-### ExpandedTermDefinition
+### ExpandedTermDefinition {#expandedtermdefinition}
 
 > `readonly` **ExpandedTermDefinition**: `"JsonLdExpandedTermDefinition"` = `"JsonLdExpandedTermDefinition"`
 
 Represents JSON-LD Expanded Term Definition.
 
-### Keyword
+### Keyword {#keyword}
 
 > `readonly` **Keyword**: `"JsonLdKeyword"` = `"JsonLdKeyword"`
 
 Represents JSON-LD Keyword.
 
-### ListOrSetItem
+### ListOrSetItem {#listorsetitem}
 
 > `readonly` **ListOrSetItem**: `"JsonLdListOrSetItem"` = `"JsonLdListOrSetItem"`
 
 Represents JSON-LD List or Set Item.
 
-### ContainerType
+### ContainerType {#containertype}
 
 > `readonly` **ContainerType**: `"JsonLdContainerType"` = `"JsonLdContainerType"`
 
 Represents JSON-LD Container Type.
 
-### ContainerTypeArray
+### ContainerTypeArray {#containertypearray}
 
 > `readonly` **ContainerTypeArray**: `"JsonLdContainerTypeArray"` = `"JsonLdContainerTypeArray"`
 
 Represents JSON-LD Container Type Array.
 
-### JsonPrimitive
+### JsonPrimitive {#jsonprimitive}
 
 > `readonly` **JsonPrimitive**: `"JsonLdJsonPrimitive"` = `"JsonLdJsonPrimitive"`
 
 Represents JSON-LD JSON Primitive.
 
-### JsonArray
+### JsonArray {#jsonarray}
 
 > `readonly` **JsonArray**: `"JsonLdJsonArray"` = `"JsonLdJsonArray"`
 
 Represents JSON-LD JSON Array.
 
-### JsonObject
+### JsonObject {#jsonobject}
 
 > `readonly` **JsonObject**: `"JsonLdJsonObject"` = `"JsonLdJsonObject"`
 
 Represents JSON-LD JSON Object.
 
-### JsonValue
+### JsonValue {#jsonvalue}
 
 > `readonly` **JsonValue**: `"JsonLdJsonValue"` = `"JsonLdJsonValue"`
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/data-json-ld",
-	"version": "0.0.3-next.2",
-	"description": "Models which define the structure of JSON LD",
+	"version": "0.0.3-next.20",
+	"description": "JSON-LD data models and helpers for working with linked data documents.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/data.git",
@@ -15,12 +15,12 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/data-core": "0.0.3-next.2",
+		"@twin.org/data-core": "0.0.3-next.20",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next",
 		"@types/jsonld": "1.5.15",
-		"jsonld": "8.3.3"
+		"jsonld": "9.0.0"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",