@twin.org/data-json-ld 0.0.1-next.17 → 0.0.1-next.20

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { DataTypeHandlerFactory, DataTypeHelper } from '@twin.org/data-core';
-import { Is, GeneralError, ObjectHelper } from '@twin.org/core';
+import { Is, ObjectHelper, GeneralError } from '@twin.org/core';
 import { FetchHelper, HttpMethod, HeaderTypes, MimeTypes } from '@twin.org/web';
 import jsonLd from 'jsonld';
 
@@ -113,6 +113,7 @@ const JsonLdTypes = {
 };
 
 var type$e = "string";
+var description$n = "Helper Types";
 var JsonLdContainerTypeSchema = {
 	type: type$e,
 	"enum": [
@@ -121,7 +122,8 @@ var JsonLdContainerTypeSchema = {
 	"@id",
 	"@graph",
 	"@type"
-]
+],
+	description: description$n
 };
 
 var anyOf$8 = [
@@ -298,29 +300,42 @@ var anyOf$8 = [
 		maxItems: 2
 	}
 ];
+var description$m = "Helper Types.";
 var JsonLdContainerTypeArraySchema = {
-	anyOf: anyOf$8
+	anyOf: anyOf$8,
+	description: description$m
 };
 
 var type$d = "object";
 var properties$6 = {
 	"@base": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+		type: [
+			"string",
+			"null"
+		]
 	},
 	"@direction": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+		type: [
+			"string",
+			"null"
+		],
+		"enum": [
+			"ltr",
+			"rtl",
+			null
+		]
 	},
 	"@import": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+		type: "string"
 	},
 	"@language": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+		type: "string"
 	},
 	"@propagate": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+		type: "boolean"
 	},
 	"@protected": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+		type: "boolean"
 	},
 	"@type": {
 		type: "object",
@@ -330,7 +345,7 @@ var properties$6 = {
 				"const": "@set"
 			},
 			"@protected": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "boolean"
 			}
 		},
 		required: [
@@ -339,10 +354,14 @@ var properties$6 = {
 		additionalProperties: false
 	},
 	"@version": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+		type: "string",
+		"const": "1.1"
 	},
 	"@vocab": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+		type: [
+			"string",
+			"null"
+		]
 	}
 };
 var additionalProperties$b = {
@@ -358,12 +377,12 @@ var additionalProperties$b = {
 		}
 	]
 };
-var description$h = "A context definition defines a local context in a node object.";
+var description$l = "A context definition defines a local context in a node object.";
 var JsonLdContextDefinitionSchema = {
 	type: type$d,
 	properties: properties$6,
 	additionalProperties: additionalProperties$b,
-	description: description$h
+	description: description$l
 };
 
 var anyOf$7 = [
@@ -409,10 +428,10 @@ var anyOf$7 = [
 		additionalProperties: false
 	}
 ];
-var description$g = "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.";
+var description$k = "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.";
 var JsonLdDocumentSchema = {
 	anyOf: anyOf$7,
-	description: description$g
+	description: description$k
 };
 
 var anyOf$6 = [
@@ -423,7 +442,13 @@ var anyOf$6 = [
 			"@id": {
 				anyOf: [
 					{
-						$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+						type: "string"
+					},
+					{
+						type: "array",
+						items: {
+							type: "string"
+						}
 					},
 					{
 						type: "null"
@@ -434,28 +459,64 @@ var anyOf$6 = [
 				type: "string"
 			},
 			"@container": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				anyOf: [
+					{
+						type: "string",
+						"const": "@list"
+					},
+					{
+						type: "string",
+						"const": "@set"
+					},
+					{
+						$ref: "https://schema.twindev.org/json-ld/JsonLdContainerType"
+					},
+					{
+						type: "array",
+						items: {
+							anyOf: [
+								{
+									type: "string",
+									"const": "@list"
+								},
+								{
+									type: "string",
+									"const": "@set"
+								},
+								{
+									$ref: "https://schema.twindev.org/json-ld/JsonLdContainerType"
+								}
+							]
+						}
+					},
+					{
+						$ref: "https://schema.twindev.org/json-ld/JsonLdContainerTypeArray"
+					},
+					{
+						type: "null"
+					}
+				]
 			},
 			"@type": {
 				type: "string"
 			},
 			"@language": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "string"
 			},
 			"@index": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "string"
 			},
 			"@context": {
 				$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinition"
 			},
 			"@prefix": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "boolean"
 			},
 			"@propagate": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "boolean"
 			},
 			"@protected": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "boolean"
 			}
 		}
 	},
@@ -464,7 +525,7 @@ var anyOf$6 = [
 		additionalProperties: false,
 		properties: {
 			"@reverse": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "string"
 			},
 			"@container": {
 				type: [
@@ -481,22 +542,22 @@ var anyOf$6 = [
 				type: "string"
 			},
 			"@language": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "string"
 			},
 			"@index": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "string"
 			},
 			"@context": {
 				$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinition"
 			},
 			"@prefix": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "boolean"
 			},
 			"@propagate": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "boolean"
 			},
 			"@protected": {
-				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
+				type: "boolean"
 			}
 		},
 		required: [
@@ -504,10 +565,10 @@ var anyOf$6 = [
 		]
 	}
 ];
-var description$f = "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.";
+var description$j = "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.";
 var JsonLdExpandedTermDefinitionSchema = {
 	anyOf: anyOf$6,
-	description: description$f
+	description: description$j
 };
 
 var type$c = "object";
@@ -526,47 +587,37 @@ var properties$5 = {
 		]
 	},
 	"@index": {
-		type: "string"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@id": {
-		anyOf: [
-			{
-				type: "string"
-			},
-			{
-				type: "array",
-				items: {
-					type: "string"
-				}
-			}
-		]
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@context": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	}
 };
 var required$3 = [
 	"@graph"
 ];
 var additionalProperties$a = false;
-var description$e = "A graph object represents a named graph, which MAY include an explicit graph name.";
+var description$i = "A graph object represents a named graph, which MAY include an explicit graph name.";
 var JsonLdGraphObjectSchema = {
 	type: type$c,
 	properties: properties$5,
 	required: required$3,
 	additionalProperties: additionalProperties$a,
-	description: description$e
+	description: description$i
 };
 
 var type$b = "object";
 var additionalProperties$9 = {
 	$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
 };
-var description$d = "An id map is used to associate an IRI with a value that allows easy programmatic access.";
+var description$h = "An id map is used to associate an IRI with a value that allows easy programmatic access.";
 var JsonLdIdMapSchema = {
 	type: type$b,
 	additionalProperties: additionalProperties$9,
-	description: description$d
+	description: description$h
 };
 
 var anyOf$5 = [
@@ -580,10 +631,10 @@ var anyOf$5 = [
 		}
 	}
 ];
-var description$c = "An included block is used to provide a set of node objects.";
+var description$g = "An included block is used to provide a set of node objects.";
 var JsonLdIncludedBlockSchema = {
 	anyOf: anyOf$5,
-	description: description$c
+	description: description$g
 };
 
 var type$a = "object";
@@ -600,11 +651,11 @@ var additionalProperties$8 = {
 		}
 	]
 };
-var description$b = "An index map allows keys that have no semantic meaning, but should be preserved regardless, to be used in JSON-LD documents.";
+var description$f = "An index map allows keys that have no semantic meaning, but should be preserved regardless, to be used in JSON-LD documents.";
 var JsonLdIndexMapSchema = {
 	type: type$a,
 	additionalProperties: additionalProperties$8,
-	description: description$b
+	description: description$f
 };
 
 var anyOf$4 = [
@@ -633,19 +684,21 @@ var anyOf$4 = [
 		$ref: "https://schema.twindev.org/json-ld/JsonLdSetObject"
 	}
 ];
-var description$a = "The items that can be stored in an index map.";
+var description$e = "The items that can be stored in an index map.";
 var JsonLdIndexMapItemSchema = {
 	anyOf: anyOf$4,
-	description: description$a
+	description: description$e
 };
 
 var type$9 = "array";
 var items = {
 	$ref: "https://schema.twindev.org/json-ld/JsonLdJsonValue"
 };
+var description$d = "JSON Type for array.";
 var JsonLdJsonArraySchema = {
 	type: type$9,
-	items: items
+	items: items,
+	description: description$d
 };
 
 var type$8 = "object";
@@ -660,9 +713,11 @@ var additionalProperties$7 = {
 		}
 	]
 };
+var description$c = "JSON Type for object.";
 var JsonLdJsonObjectSchema = {
 	type: type$8,
-	additionalProperties: additionalProperties$7
+	additionalProperties: additionalProperties$7,
+	description: description$c
 };
 
 var type$7 = [
@@ -671,8 +726,10 @@ var type$7 = [
 	"boolean",
 	"null"
 ];
+var description$b = "JSON Primitive.";
 var JsonLdJsonPrimitiveSchema = {
-	type: type$7
+	type: type$7,
+	description: description$b
 };
 
 var anyOf$3 = [
@@ -686,8 +743,10 @@ var anyOf$3 = [
 		$ref: "https://schema.twindev.org/json-ld/JsonLdJsonObject"
 	}
 ];
+var description$a = "JSON Value.";
 var JsonLdJsonValueSchema = {
-	anyOf: anyOf$3
+	anyOf: anyOf$3,
+	description: description$a
 };
 
 var type$6 = "object";
@@ -932,20 +991,10 @@ var JsonLdLanguageMapSchema = {
 var type$4 = "object";
 var properties$3 = {
 	"@list": {
-		anyOf: [
-			{
-				$ref: "https://schema.twindev.org/json-ld/JsonLdListOrSetItem"
-			},
-			{
-				type: "array",
-				items: {
-					$ref: "https://schema.twindev.org/json-ld/JsonLdListOrSetItem"
-				}
-			}
-		]
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@index": {
-		type: "string"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	}
 };
 var required$1 = [
@@ -1015,23 +1064,13 @@ var additionalProperties$3 = {
 };
 var properties$2 = {
 	"@context": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@id": {
-		anyOf: [
-			{
-				type: "string"
-			},
-			{
-				type: "array",
-				items: {
-					type: "string"
-				}
-			}
-		]
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@included": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@graph": {
 		anyOf: [
@@ -1062,12 +1101,12 @@ var properties$2 = {
 	"@type": {
 		anyOf: [
 			{
-				type: "string"
+				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 			},
 			{
 				type: "array",
 				items: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 				}
 			}
 		]
@@ -1075,11 +1114,11 @@ var properties$2 = {
 	"@reverse": {
 		type: "object",
 		additionalProperties: {
-			type: "string"
+			$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 		}
 	},
 	"@index": {
-		type: "string"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	}
 };
 var description$5 = "A node object represents zero or more properties of a node in the graph serialized by the JSON-LD document.";
@@ -1128,23 +1167,13 @@ var JsonLdNodePrimitiveSchema = {
 var type$2 = "object";
 var properties$1 = {
 	"@context": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@id": {
-		anyOf: [
-			{
-				type: "string"
-			},
-			{
-				type: "array",
-				items: {
-					type: "string"
-				}
-			}
-		]
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@included": {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@graph": {
 		anyOf: [
@@ -1175,12 +1204,12 @@ var properties$1 = {
 	"@type": {
 		anyOf: [
 			{
-				type: "string"
+				$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 			},
 			{
 				type: "array",
 				items: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 				}
 			}
 		]
@@ -1188,11 +1217,11 @@ var properties$1 = {
 	"@reverse": {
 		type: "object",
 		additionalProperties: {
-			type: "string"
+			$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 		}
 	},
 	"@index": {
-		type: "string"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	}
 };
 var additionalProperties$2 = false;
@@ -1207,20 +1236,10 @@ var JsonLdObjectSchema = {
 var type$1 = "object";
 var properties = {
 	"@set": {
-		anyOf: [
-			{
-				$ref: "https://schema.twindev.org/json-ld/JsonLdListOrSetItem"
-			},
-			{
-				type: "array",
-				items: {
-					$ref: "https://schema.twindev.org/json-ld/JsonLdListOrSetItem"
-				}
-			}
-		]
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	},
 	"@index": {
-		type: "string"
+		$ref: "https://schema.twindev.org/json-ld/JsonLdKeyword"
 	}
 };
 var required = [
@@ -1536,7 +1555,7 @@ class JsonLdProcessor {
                     context = JsonLdProcessor.gatherContexts(document, context);
                 }
             }
-            const compacted = await jsonLd.compact(document, context, {
+            const compacted = await jsonLd.compact(ObjectHelper.removeEmptyProperties(document), context, {
                 documentLoader: JsonLdProcessor.DOCUMENT_LOADER
             });
             return compacted;
@@ -1560,7 +1579,7 @@ class JsonLdProcessor {
      */
     static async expand(compacted) {
         try {
-            const expanded = await jsonLd.expand(compacted, {
+            const expanded = await jsonLd.expand(ObjectHelper.removeEmptyProperties(compacted), {
                 documentLoader: JsonLdProcessor.DOCUMENT_LOADER
             });
             return expanded;

package/dist/types/index.d.ts

@@ -1,5 +1,30 @@
 export * from "./dataTypes/jsonLdDataTypes";
+export * from "./models/IJsonLdContainerType";
+export * from "./models/IJsonLdContainerTypeArray";
+export * from "./models/IJsonLdContextDefinition";
+export * from "./models/IJsonLdContextDefinitionElement";
+export * from "./models/IJsonLdContextDefinitionRoot";
 export * from "./models/IJsonLdDocument";
+export * from "./models/IJsonLdExpandedTermDefinition";
+export * from "./models/IJsonLdGraphObject";
+export * from "./models/IJsonLdIdMap";
+export * from "./models/IJsonLdIncludedBlock";
+export * from "./models/IJsonLdIndexMap";
+export * from "./models/IJsonLdIndexMapItem";
+export * from "./models/IJsonLdJsonArray";
+export * from "./models/IJsonLdJsonObject";
+export * from "./models/IJsonLdJsonPrimitive";
+export * from "./models/IJsonLdJsonValue";
+export * from "./models/IJsonLdKeyword";
+export * from "./models/IJsonLdLanguageMap";
+export * from "./models/IJsonLdListObject";
+export * from "./models/IJsonLdListOrSetItem";
+export * from "./models/IJsonLdNodeObject";
+export * from "./models/IJsonLdNodePrimitive";
+export * from "./models/IJsonLdObject";
+export * from "./models/IJsonLdSetObject";
+export * from "./models/IJsonLdTypeMap";
+export * from "./models/IJsonLdValueObject";
 export * from "./models/jsonLdTypes";
 export * from "./utils/jsonLdHelper";
 export * from "./utils/jsonLdProcessor";

package/dist/types/models/IJsonLdContainerType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * Helper Types
+ */
+export type IJsonLdContainerType = "@language" | "@index" | "@id" | "@graph" | "@type";

package/dist/types/models/IJsonLdContainerTypeArray.d.ts

@@ -0,0 +1,9 @@
+import type { IJsonLdContainerType } from "./IJsonLdContainerType";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * Helper Types.
+ */
+export type 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, "@set"];

package/dist/types/models/IJsonLdContextDefinition.d.ts

@@ -0,0 +1,25 @@
+import type { IJsonLdExpandedTermDefinition } from "./IJsonLdExpandedTermDefinition";
+import type { IJsonLdKeyword } from "./IJsonLdKeyword";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * A context definition defines a local context in a node object.
+ * @see https://www.w3.org/TR/json-ld11/#context-definitions
+ */
+export interface IJsonLdContextDefinition {
+    [key: string]: null | string | IJsonLdExpandedTermDefinition | IJsonLdContextDefinition[keyof IJsonLdContextDefinition];
+    "@base"?: IJsonLdKeyword["@base"] | undefined;
+    "@direction"?: IJsonLdKeyword["@direction"] | undefined;
+    "@import"?: IJsonLdKeyword["@import"] | undefined;
+    "@language"?: IJsonLdKeyword["@language"] | undefined;
+    "@propagate"?: IJsonLdKeyword["@propagate"] | undefined;
+    "@protected"?: IJsonLdKeyword["@protected"] | undefined;
+    "@type"?: {
+        "@container": "@set";
+        "@protected"?: IJsonLdKeyword["@protected"] | undefined;
+    } | undefined;
+    "@version"?: IJsonLdKeyword["@version"] | undefined;
+    "@vocab"?: IJsonLdKeyword["@vocab"] | undefined;
+}

package/dist/types/models/IJsonLdContextDefinitionElement.d.ts

@@ -0,0 +1,9 @@
+import type { IJsonLdContextDefinition } from "./IJsonLdContextDefinition";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * A context definition element is used to define the types of a context definition.
+ */
+export type IJsonLdContextDefinitionElement = null | string | IJsonLdContextDefinition;

package/dist/types/models/IJsonLdContextDefinitionRoot.d.ts

@@ -0,0 +1,9 @@
+import type { IJsonLdContextDefinitionElement } from "./IJsonLdContextDefinitionElement";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * A context definition root is used to define the root of a context definition.
+ */
+export type IJsonLdContextDefinitionRoot = IJsonLdContextDefinitionElement | IJsonLdContextDefinitionElement[];