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

package/dist/esm/index.mjs

@@ -3,225 +3,296 @@ 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: "https://schema.twindev.org/aig/AuditableItemGraphVertex",
+    Vertex: "AuditableItemGraphVertex",
     /**
      * Represents auditable item graph alias.
      */
-    Alias: "https://schema.twindev.org/aig/AuditableItemGraphAlias",
+    Alias: "AuditableItemGraphAlias",
     /**
      * Represents auditable item graph resource.
      */
-    Resource: "https://schema.twindev.org/aig/AuditableItemGraphResource",
+    Resource: "AuditableItemGraphResource",
     /**
      * Represents auditable item graph edge.
      */
-    Edge: "https://schema.twindev.org/aig/AuditableItemGraphEdge",
+    Edge: "AuditableItemGraphEdge",
     /**
      * Represents auditable item graph  changeset.
      */
-    Changeset: "https://schema.twindev.org/aig/AuditableItemGraphChangeset",
+    Changeset: "AuditableItemGraphChangeset",
     /**
      * Represents patch operation.
      */
-    PatchOperation: "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation",
-    /**
-     * Represents the immutable credential payload.
-     */
-    Credential: "https://schema.twindev.org/aig/AuditableItemGraphPatchCredential",
-    /**
-     * Represents auditable item stream verification.
-     */
-    Verification: "https://schema.twindev.org/aig/AuditableItemGraphVerification",
-    /**
-     * Represents auditable item stream verification state.
-     */
-    VerificationState: "https://schema.twindev.org/aig/AuditableItemGraphVerificationState"
+    PatchOperation: "AuditableItemGraphPatchOperation"
 };
 
-var type$8 = "object";
-var properties$7 = {
-	metadata: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata to associate with the element as JSON-LD."
-	},
+var type$5 = "object";
+var properties$5 = {
 	id: {
 		type: "string",
 		description: "The id of the element."
 	},
-	created: {
-		type: "number",
-		description: "The timestamp of when the element was created."
+	dateCreated: {
+		type: "string",
+		description: "The date/time of when the element was created."
+	},
+	dateModified: {
+		type: "string",
+		description: "The date/time of when the element was modified."
+	},
+	dateDeleted: {
+		type: "string",
+		description: "The date/time of when the element was deleted, as we never actually remove items."
+	},
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/aig/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/aig/"
+					}
+				],
+				additionalItems: {
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+				}
+			}
+		],
+		description: "JSON-LD Context."
 	},
-	updated: {
-		type: "number",
-		description: "The timestamp of when the element was updated."
+	type: {
+		type: "string",
+		"const": "AuditableItemGraphAlias",
+		description: "JSON-LD Type."
 	},
-	deleted: {
-		type: "number",
-		description: "The timestamp of when the element was deleted, as we never actually remove items."
+	annotationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The JSON-LD annotation object for the alias."
 	},
-	format: {
+	aliasFormat: {
 		type: "string",
 		description: "The format of the id in the alias."
 	}
 };
-var additionalProperties$7 = false;
-var required$6 = [
-	"created",
-	"id"
+var required$5 = [
+	"@context",
+	"id",
+	"type"
 ];
-var description$7 = "Interface describing an alias for a vertex.";
+var additionalProperties$5 = false;
+var description$5 = "Interface describing an alias for a vertex.";
 var AuditableItemGraphAliasSchema = {
-	type: type$8,
-	properties: properties$7,
-	additionalProperties: additionalProperties$7,
-	required: required$6,
-	description: description$7
+	type: type$5,
+	properties: properties$5,
+	required: required$5,
+	additionalProperties: additionalProperties$5,
+	description: description$5
 };
 
-var type$7 = "object";
-var properties$6 = {
-	created: {
-		type: "number",
-		description: "The timestamp of when the changeset was created."
-	},
-	userIdentity: {
-		type: "string",
-		description: "The user identity that created the changes."
-	},
-	patches: {
+var type$4 = "object";
+var properties$4 = {
+	"@context": {
 		type: "array",
-		items: {
-			$ref: "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"
+		minItems: 2,
+		items: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/aig/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
+			}
+		],
+		additionalItems: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 		},
-		description: "The patches in the changeset."
+		description: "JSON-LD Context."
 	},
-	hash: {
+	type: {
 		type: "string",
-		description: "The hash for the changeset."
+		"const": "AuditableItemGraphChangeset",
+		description: "JSON-LD Type."
 	},
-	signature: {
+	id: {
 		type: "string",
-		description: "The signature for the changeset."
+		description: "The id of the changeset."
 	},
-	immutableStorageId: {
+	dateCreated: {
 		type: "string",
-		description: "The immutable storage id containing the signature for the changeset."
-	}
-};
-var required$5 = [
-	"created",
-	"userIdentity",
-	"patches",
-	"hash",
-	"signature"
-];
-var additionalProperties$6 = false;
-var description$6 = "Interface describing a set of updates to the vertex.";
-var AuditableItemGraphChangesetSchema = {
-	type: type$7,
-	properties: properties$6,
-	required: required$5,
-	additionalProperties: additionalProperties$6,
-	description: description$6
-};
-
-var type$6 = "object";
-var properties$5 = {
-	created: {
-		type: "number",
-		description: "The timestamp of when the changeset was created."
+		description: "The date/time of when the changeset was created."
 	},
 	userIdentity: {
 		type: "string",
 		description: "The user identity that created the changes."
 	},
-	signature: {
-		type: "string",
-		description: "The signature for the changeset."
+	patches: {
+		type: "array",
+		items: {
+			$ref: "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"
+		},
+		description: "The patches in the changeset."
 	},
-	hash: {
+	proofId: {
 		type: "string",
-		description: "The signature for the changeset."
+		description: "The immutable proof id which contains the signature for this changeset."
 	},
-	integrity: {
-		type: "string",
-		description: "The integrity data for this changeset, encrypted."
+	verification: {
+		$ref: "https://schema.twindev.org/immutable-proof/ImmutableProofVerification",
+		description: "The verification for the changeset."
 	}
 };
 var required$4 = [
-	"created",
+	"@context",
+	"type",
+	"id",
+	"dateCreated",
 	"userIdentity",
-	"signature",
-	"hash"
+	"patches"
 ];
-var additionalProperties$5 = false;
-var description$5 = "The data stored immutably for the graph in a verifiable credential.";
-var AuditableItemGraphCredentialSchema = {
-	type: type$6,
-	properties: properties$5,
+var additionalProperties$4 = false;
+var description$4 = "Interface describing a set of changes to the vertex.";
+var AuditableItemGraphChangesetSchema = {
+	type: type$4,
+	properties: properties$4,
 	required: required$4,
-	additionalProperties: additionalProperties$5,
-	description: description$5
+	additionalProperties: additionalProperties$4,
+	description: description$4
 };
 
-var type$5 = "object";
-var properties$4 = {
-	metadata: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata to associate with the element as JSON-LD."
-	},
+var type$3 = "object";
+var properties$3 = {
 	id: {
 		type: "string",
 		description: "The id of the element."
 	},
-	created: {
-		type: "number",
-		description: "The timestamp of when the element was created."
+	dateCreated: {
+		type: "string",
+		description: "The date/time of when the element was created."
 	},
-	updated: {
-		type: "number",
-		description: "The timestamp of when the element was updated."
+	dateModified: {
+		type: "string",
+		description: "The date/time of when the element was modified."
 	},
-	deleted: {
-		type: "number",
-		description: "The timestamp of when the element was deleted, as we never actually remove items."
+	dateDeleted: {
+		type: "string",
+		description: "The date/time of when the element was deleted, as we never actually remove items."
+	},
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/aig/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/aig/"
+					}
+				],
+				additionalItems: {
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+				}
+			}
+		],
+		description: "JSON-LD Context."
 	},
-	relationship: {
+	type: {
 		type: "string",
-		description: "The relationship between the two vertices."
+		"const": "AuditableItemGraphEdge",
+		description: "JSON-LD Type."
+	},
+	annotationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The JSON-LD annotation object for the edge."
+	},
+	edgeRelationships: {
+		type: "array",
+		items: {
+			type: "string"
+		},
+		description: "The relationships between the two vertices."
 	}
 };
 var required$3 = [
-	"created",
+	"@context",
 	"id",
-	"relationship"
+	"type",
+	"edgeRelationships"
 ];
-var additionalProperties$4 = false;
-var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
+var additionalProperties$3 = false;
+var description$3 = "Interface describing an edge between two vertices in an auditable item graph.";
 var AuditableItemGraphEdgeSchema = {
-	type: type$5,
-	properties: properties$4,
+	type: type$3,
+	properties: properties$3,
 	required: required$3,
-	additionalProperties: additionalProperties$4,
-	description: description$4
+	additionalProperties: additionalProperties$3,
+	description: description$3
 };
 
-var type$4 = "object";
-var additionalProperties$3 = false;
-var properties$3 = {
-	op: {
+var type$2 = "object";
+var properties$2 = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/aig/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/aig/"
+					}
+				],
+				additionalItems: {
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "AuditableItemGraphPatchOperation",
+		description: "JSON-LD Type."
+	},
+	patchOperation: {
 		type: "string",
 		"enum": [
 			"add",
@@ -233,116 +304,147 @@ var properties$3 = {
 		],
 		description: "The operation that was performed on the item."
 	},
-	path: {
+	patchPath: {
 		type: "string",
 		description: "The path to the object that was changed."
 	},
-	from: {
+	patchFrom: {
 		type: "string",
 		description: "The path the value was copied or moved from."
 	},
-	value: {
+	patchValue: {
 		description: "The value to add."
 	}
 };
 var required$2 = [
-	"op",
-	"path"
+	"@context",
+	"type",
+	"patchOperation",
+	"patchPath"
 ];
-var description$3 = "The patch operation for JSON diffs.";
+var additionalProperties$2 = false;
+var description$2 = "The patch operation for JSON diffs.";
 var AuditableItemGraphPatchOperationSchema = {
-	type: type$4,
-	additionalProperties: additionalProperties$3,
-	properties: properties$3,
+	type: type$2,
+	properties: properties$2,
 	required: required$2,
-	description: description$3
+	additionalProperties: additionalProperties$2,
+	description: description$2
 };
 
-var type$3 = "object";
-var additionalProperties$2 = false;
-var properties$2 = {
-	metadata: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata to associate with the element as JSON-LD."
-	},
+var type$1 = "object";
+var properties$1 = {
 	id: {
 		type: "string",
 		description: "The id of the element."
 	},
-	created: {
-		type: "number",
-		description: "The timestamp of when the element was created."
+	dateCreated: {
+		type: "string",
+		description: "The date/time of when the element was created."
 	},
-	updated: {
-		type: "number",
-		description: "The timestamp of when the element was updated."
+	dateModified: {
+		type: "string",
+		description: "The date/time of when the element was modified."
 	},
-	deleted: {
-		type: "number",
-		description: "The timestamp of when the element was deleted, as we never actually remove items."
+	dateDeleted: {
+		type: "string",
+		description: "The date/time of when the element was deleted, as we never actually remove items."
+	},
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/aig/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/aig/"
+					}
+				],
+				additionalItems: {
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "AuditableItemGraphResource",
+		description: "JSON-LD Type."
+	},
+	resourceObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The JSON-LD object for the resource."
 	}
 };
 var required$1 = [
-	"created",
-	"id"
+	"@context",
+	"type"
 ];
-var description$2 = "Interface describing an auditable item graph vertex resource.";
+var additionalProperties$1 = false;
+var description$1 = "Interface describing an auditable item graph vertex resource.";
 var AuditableItemGraphResourceSchema = {
-	type: type$3,
-	additionalProperties: additionalProperties$2,
-	properties: properties$2,
-	required: required$1,
-	description: description$2
-};
-
-var type$2 = "object";
-var properties$1 = {
-	epoch: {
-		type: "number",
-		description: "The epoch of the verification."
-	},
-	state: {
-		$ref: "https://schema.twindev.org/aig/AuditableItemGraphVerificationState",
-		description: "The state of the verification."
-	}
-};
-var required = [
-	"epoch",
-	"state"
-];
-var additionalProperties$1 = {
-};
-var description$1 = "Interface describing an auditable item graph verification.";
-var AuditableItemGraphVerificationSchema = {
-	type: type$2,
+	type: type$1,
 	properties: properties$1,
-	required: required,
+	required: required$1,
 	additionalProperties: additionalProperties$1,
 	description: description$1
 };
 
-var type$1 = "string";
-var description = "The state of the verification.";
-var AuditableItemGraphVerificationStateSchema = {
-	type: type$1,
-	"enum": [
-	"ok",
-	"hashMismatch",
-	"signatureNotVerified",
-	"credentialRevoked",
-	"immutableHashMismatch",
-	"immutableSignatureMismatch",
-	"integrityDataMismatch"
-],
-	description: description
-};
-
 var type = "object";
 var properties = {
+	id: {
+		type: "string",
+		description: "The id of the element."
+	},
+	dateCreated: {
+		type: "string",
+		description: "The date/time of when the element was created."
+	},
+	dateModified: {
+		type: "string",
+		description: "The date/time of when the element was modified."
+	},
+	dateDeleted: {
+		type: "string",
+		description: "The date/time of when the element was deleted, as we never actually remove items."
+	},
+	"@context": {
+		type: "array",
+		minItems: 2,
+		items: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/aig/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
+			}
+		],
+		additionalItems: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "AuditableItemGraphVertex",
+		description: "JSON-LD Type."
+	},
 	nodeIdentity: {
 		type: "string",
 		description: "The identity of the node which controls the vertex."
 	},
+	annotationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The JSON-LD annotation object for the vertex."
+	},
 	aliases: {
 		type: "array",
 		items: {
@@ -371,28 +473,24 @@ var properties = {
 		},
 		description: "Changesets for the vertex."
 	},
-	id: {
-		type: "string",
-		description: "The id of the element."
-	},
-	created: {
-		type: "number",
-		description: "The timestamp of when the element was created."
-	},
-	updated: {
-		type: "number",
-		description: "The timestamp of when the element was updated."
-	},
-	metadata: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata to associate with the element as JSON-LD."
+	verified: {
+		type: "boolean",
+		description: "Is the vertex verified, will only be populated when verification is requested."
 	}
 };
+var required = [
+	"@context",
+	"id",
+	"type"
+];
 var additionalProperties = false;
+var description = "Interface describing an auditable item graph vertex.";
 var AuditableItemGraphVertexSchema = {
 	type: type,
 	properties: properties,
-	additionalProperties: additionalProperties
+	required: required,
+	additionalProperties: additionalProperties,
+	description: description
 };
 
 // Copyright 2024 IOTA Stiftung.
@@ -405,89 +503,60 @@ 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.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.Credential, () => ({
-            type: AuditableItemGraphTypes.Credential,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphCredentialSchema
-        }));
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.Verification, () => ({
-            type: AuditableItemGraphTypes.Verification,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphVerificationSchema
-        }));
-        DataTypeHandlerFactory.register(AuditableItemGraphTypes.VerificationState, () => ({
-            type: AuditableItemGraphTypes.VerificationState,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphVerificationStateSchema
-        }));
     }
 }
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The state of the verification.
+ * The topics for auditable item graph event bus notifications.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const AuditableItemGraphVerificationState = {
-    /**
-     * OK.
-     */
-    Ok: "ok",
-    /**
-     * The stored hash does not matched the calculated one.
-     */
-    HashMismatch: "hashMismatch",
-    /**
-     * The signature verification failed.
-     */
-    SignatureNotVerified: "signatureNotVerified",
-    /**
-     * The credential in the immutable storage was revoked.
-     */
-    CredentialRevoked: "credentialRevoked",
-    /**
-     * Immutable hash mismatch.
-     */
-    ImmutableHashMismatch: "immutableHashMismatch",
+const AuditableItemGraphTopics = {
     /**
-     * Immutable signature mismatch.
+     * A vertex was created.
      */
-    ImmutableSignatureMismatch: "immutableSignatureMismatch",
+    VertexCreated: "auditable-item-graph:vertex-created",
     /**
-     * Integrity data mismatch.
+     * A vertex was updated.
      */
-    IntegrityDataMismatch: "integrityDataMismatch"
+    VertexUpdated: "auditable-item-graph:vertex-updated"
 };
 
 // Copyright 2024 IOTA Stiftung.
@@ -511,4 +580,4 @@ const VerifyDepth = {
     All: "all"
 };
 
-export { AuditableItemGraphDataTypes, AuditableItemGraphTypes, AuditableItemGraphVerificationState, VerifyDepth };
+export { AuditableItemGraphContexts, AuditableItemGraphDataTypes, AuditableItemGraphTopics, AuditableItemGraphTypes, VerifyDepth };