@twin.org/auditable-item-graph-models 0.0.1-next.9 → 0.0.1

package/dist/esm/index.mjs

@@ -3,18 +3,35 @@ import { DataTypeHandlerFactory } from '@twin.org/data-core';
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The types of auditable item graph data.
+ * The contexts of auditable item graph data.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const AuditableItemGraphTypes = {
+const AuditableItemGraphContexts = {
     /**
      * The context root for the auditable item graph types.
      */
     ContextRoot: "https://schema.twindev.org/aig/",
+    /**
+     * The context root for the common types.
+     */
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of auditable item graph data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuditableItemGraphTypes = {
     /**
      * Represents auditable item graph vertex.
      */
     Vertex: "AuditableItemGraphVertex",
+    /**
+     * Represents auditable item graph vertex list.
+     */
+    VertexList: "AuditableItemGraphVertexList",
     /**
      * Represents auditable item graph alias.
      */
@@ -34,13 +51,12 @@ const AuditableItemGraphTypes = {
     /**
      * Represents patch operation.
      */
-    PatchOperation: "AuditableItemGraphPatchOperation",
-    /**
-     * Represents auditable item stream vertex list.
-     */
-    VertexList: "AuditableItemGraphVertexList"
+    PatchOperation: "AuditableItemGraphPatchOperation"
 };
 
+var $schema$6 = "https://json-schema.org/draft/2020-12/schema";
+var $id$6 = "https://schema.twindev.org/aig/AuditableItemGraphAlias";
+var description$6 = "Interface describing an alias for a vertex.";
 var type$6 = "object";
 var properties$6 = {
 	id: {
@@ -68,15 +84,15 @@ var properties$6 = {
 			{
 				type: "array",
 				minItems: 1,
-				items: [
+				items: {
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+				},
+				prefixItems: [
 					{
 						type: "string",
 						"const": "https://schema.twindev.org/aig/"
 					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				]
 			}
 		],
 		description: "JSON-LD Context."
@@ -86,9 +102,9 @@ var properties$6 = {
 		"const": "AuditableItemGraphAlias",
 		description: "JSON-LD Type."
 	},
-	aliasObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the alias."
+		description: "The JSON-LD annotation object for the alias."
 	},
 	aliasFormat: {
 		type: "string",
@@ -97,43 +113,42 @@ var properties$6 = {
 };
 var required$6 = [
 	"@context",
-	"dateCreated",
 	"id",
 	"type"
 ];
 var additionalProperties$6 = false;
-var description$6 = "Interface describing an alias for a vertex.";
 var AuditableItemGraphAliasSchema = {
+	$schema: $schema$6,
+	$id: $id$6,
+	description: description$6,
 	type: type$6,
 	properties: properties$6,
 	required: required$6,
-	additionalProperties: additionalProperties$6,
-	description: description$6
+	additionalProperties: additionalProperties$6
 };
 
+var $schema$5 = "https://json-schema.org/draft/2020-12/schema";
+var $id$5 = "https://schema.twindev.org/aig/AuditableItemGraphChangeset";
+var description$5 = "Interface describing a set of changes to the vertex.";
 var type$5 = "object";
 var properties$5 = {
 	"@context": {
-		anyOf: [
+		type: "array",
+		minItems: 2,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
 			{
 				type: "string",
 				"const": "https://schema.twindev.org/aig/"
 			},
 			{
-				type: "array",
-				minItems: 1,
-				items: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/aig/"
-					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
 			}
-		],
-		description: "JSON-LD Context."
+		]
 	},
 	type: {
 		type: "string",
@@ -154,10 +169,13 @@ var properties$5 = {
 	},
 	patches: {
 		type: "array",
-		items: {
-			$ref: "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"
-		},
-		description: "The patches in the changeset."
+		items: false,
+		description: "The patches in the changeset.",
+		prefixItems: [
+			{
+				$ref: "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"
+			}
+		]
 	},
 	proofId: {
 		type: "string",
@@ -177,15 +195,19 @@ var required$5 = [
 	"patches"
 ];
 var additionalProperties$5 = false;
-var description$5 = "Interface describing a set of updates to the vertex.";
 var AuditableItemGraphChangesetSchema = {
+	$schema: $schema$5,
+	$id: $id$5,
+	description: description$5,
 	type: type$5,
 	properties: properties$5,
 	required: required$5,
-	additionalProperties: additionalProperties$5,
-	description: description$5
+	additionalProperties: additionalProperties$5
 };
 
+var $schema$4 = "https://json-schema.org/draft/2020-12/schema";
+var $id$4 = "https://schema.twindev.org/aig/AuditableItemGraphEdge";
+var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
 var type$4 = "object";
 var properties$4 = {
 	id: {
@@ -213,15 +235,15 @@ var properties$4 = {
 			{
 				type: "array",
 				minItems: 1,
-				items: [
+				items: {
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+				},
+				prefixItems: [
 					{
 						type: "string",
 						"const": "https://schema.twindev.org/aig/"
 					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				]
 			}
 		],
 		description: "JSON-LD Context."
@@ -231,32 +253,41 @@ var properties$4 = {
 		"const": "AuditableItemGraphEdge",
 		description: "JSON-LD Type."
 	},
-	edgeObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the edge."
+		description: "The JSON-LD annotation object for the edge."
 	},
-	edgeRelationship: {
-		type: "string",
-		description: "The relationship between the two vertices."
+	edgeRelationships: {
+		type: "array",
+		items: false,
+		description: "The relationships between the two vertices.",
+		prefixItems: [
+			{
+				type: "string"
+			}
+		]
 	}
 };
 var required$4 = [
 	"@context",
-	"dateCreated",
-	"edgeRelationship",
 	"id",
-	"type"
+	"type",
+	"edgeRelationships"
 ];
 var additionalProperties$4 = false;
-var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
 var AuditableItemGraphEdgeSchema = {
+	$schema: $schema$4,
+	$id: $id$4,
+	description: description$4,
 	type: type$4,
 	properties: properties$4,
 	required: required$4,
-	additionalProperties: additionalProperties$4,
-	description: description$4
+	additionalProperties: additionalProperties$4
 };
 
+var $schema$3 = "https://json-schema.org/draft/2020-12/schema";
+var $id$3 = "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation";
+var description$3 = "The patch operation for JSON diffs.";
 var type$3 = "object";
 var properties$3 = {
 	"@context": {
@@ -268,15 +299,15 @@ var properties$3 = {
 			{
 				type: "array",
 				minItems: 1,
-				items: [
+				items: {
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+				},
+				prefixItems: [
 					{
 						type: "string",
 						"const": "https://schema.twindev.org/aig/"
 					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				]
 			}
 		],
 		description: "JSON-LD Context."
@@ -317,15 +348,19 @@ var required$3 = [
 	"patchPath"
 ];
 var additionalProperties$3 = false;
-var description$3 = "The patch operation for JSON diffs.";
 var AuditableItemGraphPatchOperationSchema = {
+	$schema: $schema$3,
+	$id: $id$3,
+	description: description$3,
 	type: type$3,
 	properties: properties$3,
 	required: required$3,
-	additionalProperties: additionalProperties$3,
-	description: description$3
+	additionalProperties: additionalProperties$3
 };
 
+var $schema$2 = "https://json-schema.org/draft/2020-12/schema";
+var $id$2 = "https://schema.twindev.org/aig/AuditableItemGraphResource";
+var description$2 = "Interface describing an auditable item graph vertex resource.";
 var type$2 = "object";
 var properties$2 = {
 	id: {
@@ -353,15 +388,15 @@ var properties$2 = {
 			{
 				type: "array",
 				minItems: 1,
-				items: [
+				items: {
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+				},
+				prefixItems: [
 					{
 						type: "string",
 						"const": "https://schema.twindev.org/aig/"
 					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				]
 			}
 		],
 		description: "JSON-LD Context."
@@ -378,20 +413,22 @@ var properties$2 = {
 };
 var required$2 = [
 	"@context",
-	"dateCreated",
-	"id",
 	"type"
 ];
 var additionalProperties$2 = false;
-var description$2 = "Interface describing an auditable item graph vertex resource.";
 var AuditableItemGraphResourceSchema = {
+	$schema: $schema$2,
+	$id: $id$2,
+	description: description$2,
 	type: type$2,
 	properties: properties$2,
 	required: required$2,
-	additionalProperties: additionalProperties$2,
-	description: description$2
+	additionalProperties: additionalProperties$2
 };
 
+var $schema$1 = "https://json-schema.org/draft/2020-12/schema";
+var $id$1 = "https://schema.twindev.org/aig/AuditableItemGraphVertex";
+var description$1 = "Interface describing an auditable item graph vertex.";
 var type$1 = "object";
 var properties$1 = {
 	id: {
@@ -411,26 +448,22 @@ var properties$1 = {
 		description: "The date/time of when the element was deleted, as we never actually remove items."
 	},
 	"@context": {
-		anyOf: [
+		type: "array",
+		minItems: 2,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
 			{
 				type: "string",
 				"const": "https://schema.twindev.org/aig/"
 			},
 			{
-				type: "array",
-				minItems: 1,
-				items: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/aig/"
-					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
 			}
-		],
-		description: "JSON-LD Context."
+		]
 	},
 	type: {
 		type: "string",
@@ -441,37 +474,49 @@ var properties$1 = {
 		type: "string",
 		description: "The identity of the node which controls the vertex."
 	},
-	vertexObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the vertex."
+		description: "The JSON-LD annotation object for the vertex."
 	},
 	aliases: {
 		type: "array",
-		items: {
-			$ref: "https://schema.twindev.org/aig/AuditableItemGraphAlias"
-		},
-		description: "Alternative aliases that can be used to identify the vertex."
+		items: false,
+		description: "Alternative aliases that can be used to identify the vertex.",
+		prefixItems: [
+			{
+				$ref: "https://schema.twindev.org/aig/AuditableItemGraphAlias"
+			}
+		]
 	},
 	resources: {
 		type: "array",
-		items: {
-			$ref: "https://schema.twindev.org/aig/AuditableItemGraphResource"
-		},
-		description: "The resources attached to the vertex."
+		items: false,
+		description: "The resources attached to the vertex.",
+		prefixItems: [
+			{
+				$ref: "https://schema.twindev.org/aig/AuditableItemGraphResource"
+			}
+		]
 	},
 	edges: {
 		type: "array",
-		items: {
-			$ref: "https://schema.twindev.org/aig/AuditableItemGraphEdge"
-		},
-		description: "Edges connected to the vertex."
+		items: false,
+		description: "Edges connected to the vertex.",
+		prefixItems: [
+			{
+				$ref: "https://schema.twindev.org/aig/AuditableItemGraphEdge"
+			}
+		]
 	},
 	changesets: {
 		type: "array",
-		items: {
-			$ref: "https://schema.twindev.org/aig/AuditableItemGraphChangeset"
-		},
-		description: "Changesets for the vertex."
+		items: false,
+		description: "Changesets for the vertex.",
+		prefixItems: [
+			{
+				$ref: "https://schema.twindev.org/aig/AuditableItemGraphChangeset"
+			}
+		]
 	},
 	verified: {
 		type: "boolean",
@@ -480,57 +525,71 @@ var properties$1 = {
 };
 var required$1 = [
 	"@context",
-	"dateCreated",
 	"id",
 	"type"
 ];
 var additionalProperties$1 = false;
-var description$1 = "Interface describing an auditable item graph vertex.";
 var AuditableItemGraphVertexSchema = {
+	$schema: $schema$1,
+	$id: $id$1,
+	description: description$1,
 	type: type$1,
 	properties: properties$1,
 	required: required$1,
-	additionalProperties: additionalProperties$1,
-	description: description$1
+	additionalProperties: additionalProperties$1
 };
 
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/aig/AuditableItemGraphVertexList";
+var description = "Interface describing an auditable item graph vertex list.";
 var type = "object";
 var properties = {
 	"@context": {
-		anyOf: [
+		type: "array",
+		minItems: 2,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
 			{
 				type: "string",
-				"const": "https://schema.twindev.org/aig/"
+				"const": "https://schema.org"
 			},
 			{
-				type: "array",
-				minItems: 1,
-				items: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/aig/"
-					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				type: "string",
+				"const": "https://schema.twindev.org/aig/"
 			}
-		],
-		description: "JSON-LD Context."
+		]
 	},
 	type: {
-		type: "string",
-		"const": "AuditableItemGraphVertexList",
-		description: "JSON-LD Type."
+		type: "array",
+		minItems: 2,
+		items: false,
+		maxItems: 2,
+		description: "JSON-LD Type.",
+		prefixItems: [
+			{
+				type: "string",
+				"const": "ItemList"
+			},
+			{
+				type: "string",
+				"const": "AuditableItemGraphVertexList"
+			}
+		]
 	},
-	vertices: {
+	itemListElement: {
 		type: "array",
-		items: {
-			$ref: "https://schema.twindev.org/aig/AuditableItemGraphVertex"
-		},
-		description: "The list of vertices."
+		items: false,
+		description: "The list of vertices.",
+		prefixItems: [
+			{
+				$ref: "https://schema.twindev.org/aig/AuditableItemGraphVertex"
+			}
+		]
 	},
-	cursor: {
+	nextItem: {
 		type: "string",
 		description: "The cursor to get the next chunk of vertices."
 	}
@@ -538,16 +597,17 @@ var properties = {
 var required = [
 	"@context",
 	"type",
-	"vertices"
+	"itemListElement"
 ];
 var additionalProperties = false;
-var description = "Interface describing an auditable item graph vertex list.";
 var AuditableItemGraphVertexListSchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
 	type: type,
 	properties: properties,
 	required: required,
-	additionalProperties: additionalProperties,
-	description: description
+	additionalProperties: additionalProperties
 };
 
 // Copyright 2024 IOTA Stiftung.
@@ -560,44 +620,68 @@ class AuditableItemGraphDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.Vertex, () => ({
+        DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Vertex}`, () => ({
+            context: AuditableItemGraphContexts.ContextRoot,
             type: AuditableItemGraphTypes.Vertex,
             defaultValue: {},
             jsonSchema: async () => AuditableItemGraphVertexSchema
         }));
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.Alias, () => ({
+        DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.VertexList}`, () => ({
+            context: AuditableItemGraphContexts.ContextRoot,
+            type: AuditableItemGraphTypes.VertexList,
+            defaultValue: {},
+            jsonSchema: async () => AuditableItemGraphVertexListSchema
+        }));
+        DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Alias}`, () => ({
+            context: AuditableItemGraphContexts.ContextRoot,
             type: AuditableItemGraphTypes.Alias,
             defaultValue: {},
             jsonSchema: async () => AuditableItemGraphAliasSchema
         }));
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.Resource, () => ({
+        DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Resource}`, () => ({
+            context: AuditableItemGraphContexts.ContextRoot,
             type: AuditableItemGraphTypes.Resource,
             defaultValue: {},
             jsonSchema: async () => AuditableItemGraphResourceSchema
         }));
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.Edge, () => ({
+        DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Edge}`, () => ({
+            context: AuditableItemGraphContexts.ContextRoot,
             type: AuditableItemGraphTypes.Edge,
             defaultValue: {},
             jsonSchema: async () => AuditableItemGraphEdgeSchema
         }));
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.Changeset, () => ({
+        DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Changeset}`, () => ({
+            context: AuditableItemGraphContexts.ContextRoot,
             type: AuditableItemGraphTypes.Changeset,
             defaultValue: {},
             jsonSchema: async () => AuditableItemGraphChangesetSchema
         }));
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.PatchOperation, () => ({
+        DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.PatchOperation}`, () => ({
+            context: AuditableItemGraphContexts.ContextRoot,
             type: AuditableItemGraphTypes.PatchOperation,
             defaultValue: {},
             jsonSchema: async () => AuditableItemGraphPatchOperationSchema
         }));
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.VertexList, () => ({
-            type: AuditableItemGraphTypes.VertexList,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphVertexListSchema
-        }));
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The topics for auditable item graph event bus notifications.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuditableItemGraphTopics = {
+    /**
+     * A vertex was created.
+     */
+    VertexCreated: "auditable-item-graph:vertex-created",
+    /**
+     * A vertex was updated.
+     */
+    VertexUpdated: "auditable-item-graph:vertex-updated"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -619,4 +703,4 @@ const VerifyDepth = {
     All: "all"
 };
 
-export { AuditableItemGraphDataTypes, AuditableItemGraphTypes, VerifyDepth };
+export { AuditableItemGraphContexts, AuditableItemGraphDataTypes, AuditableItemGraphTopics, AuditableItemGraphTypes, VerifyDepth };

package/dist/types/index.d.ts

@@ -5,7 +5,11 @@ export * from "./models/api/IAuditableItemGraphGetResponse";
 export * from "./models/api/IAuditableItemGraphListRequest";
 export * from "./models/api/IAuditableItemGraphListResponse";
 export * from "./models/api/IAuditableItemGraphUpdateRequest";
+export * from "./models/auditableItemGraphContexts";
+export * from "./models/auditableItemGraphTopics";
 export * from "./models/auditableItemGraphTypes";
+export * from "./models/eventBus/IAuditableItemGraphEventBusVertexCreated";
+export * from "./models/eventBus/IAuditableItemGraphEventBusVertexUpdated";
 export * from "./models/IAuditableItemGraphAlias";
 export * from "./models/IAuditableItemGraphAuditedElement";
 export * from "./models/IAuditableItemGraphChangeset";