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

package/dist/esm/index.mjs

@@ -35,26 +35,14 @@ const AuditableItemGraphTypes = {
      * Represents patch operation.
      */
     PatchOperation: "AuditableItemGraphPatchOperation",
-    /**
-     * Represents the immutable credential payload.
-     */
-    Credential: "AuditableItemGraphPatchCredential",
-    /**
-     * Represents auditable item stream verification.
-     */
-    Verification: "AuditableItemGraphVerification",
-    /**
-     * Represents auditable item stream verification state.
-     */
-    VerificationState: "AuditableItemGraphVerificationState",
     /**
      * Represents auditable item stream vertex list.
      */
     VertexList: "AuditableItemGraphVertexList"
 };
 
-var type$9 = "object";
-var properties$8 = {
+var type$6 = "object";
+var properties$6 = {
 	id: {
 		type: "string",
 		description: "The id of the element."
@@ -107,24 +95,24 @@ var properties$8 = {
 		description: "The format of the id in the alias."
 	}
 };
-var required$8 = [
+var required$6 = [
 	"@context",
 	"dateCreated",
 	"id",
 	"type"
 ];
-var additionalProperties$8 = false;
-var description$9 = "Interface describing an alias for a vertex.";
+var additionalProperties$6 = false;
+var description$6 = "Interface describing an alias for a vertex.";
 var AuditableItemGraphAliasSchema = {
-	type: type$9,
-	properties: properties$8,
-	required: required$8,
-	additionalProperties: additionalProperties$8,
-	description: description$9
+	type: type$6,
+	properties: properties$6,
+	required: required$6,
+	additionalProperties: additionalProperties$6,
+	description: description$6
 };
 
-var type$8 = "object";
-var properties$7 = {
+var type$5 = "object";
+var properties$5 = {
 	"@context": {
 		anyOf: [
 			{
@@ -152,6 +140,10 @@ var properties$7 = {
 		"const": "AuditableItemGraphChangeset",
 		description: "JSON-LD Type."
 	},
+	id: {
+		type: "string",
+		description: "The id of the changeset."
+	},
 	dateCreated: {
 		type: "string",
 		description: "The date/time of when the changeset was created."
@@ -167,108 +159,35 @@ var properties$7 = {
 		},
 		description: "The patches in the changeset."
 	},
-	hash: {
+	proofId: {
 		type: "string",
-		description: "The hash for the changeset."
+		description: "The immutable proof id which contains the signature for this changeset."
 	},
-	signature: {
-		type: "string",
-		description: "The signature for the changeset."
-	},
-	immutableStorageId: {
-		type: "string",
-		description: "The immutable storage id containing the signature for the changeset."
+	verification: {
+		$ref: "https://schema.twindev.org/immutable-proof/ImmutableProofVerification",
+		description: "The verification for the changeset."
 	}
 };
-var required$7 = [
+var required$5 = [
 	"@context",
 	"type",
+	"id",
 	"dateCreated",
 	"userIdentity",
-	"patches",
-	"hash",
-	"signature"
+	"patches"
 ];
-var additionalProperties$7 = false;
-var description$8 = "Interface describing a set of updates to the vertex.";
+var additionalProperties$5 = false;
+var description$5 = "Interface describing a set of updates to the vertex.";
 var AuditableItemGraphChangesetSchema = {
-	type: type$8,
-	properties: properties$7,
-	required: required$7,
-	additionalProperties: additionalProperties$7,
-	description: description$8
-};
-
-var type$7 = "object";
-var properties$6 = {
-	"@context": {
-		anyOf: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/aig/"
-			},
-			{
-				type: "array",
-				minItems: 1,
-				items: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/aig/"
-					}
-				],
-				additionalItems: {
-					type: "string"
-				}
-			}
-		],
-		description: "JSON-LD Context."
-	},
-	type: {
-		type: "string",
-		"const": "AuditableItemGraphPatchCredential",
-		description: "JSON-LD Type."
-	},
-	dateCreated: {
-		type: "string",
-		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."
-	},
-	hash: {
-		type: "string",
-		description: "The signature for the changeset."
-	},
-	integrity: {
-		type: "string",
-		description: "The integrity data for this changeset, encrypted."
-	}
-};
-var required$6 = [
-	"@context",
-	"type",
-	"dateCreated",
-	"userIdentity",
-	"signature",
-	"hash"
-];
-var additionalProperties$6 = false;
-var description$7 = "The data stored immutably for the graph in a verifiable credential.";
-var AuditableItemGraphCredentialSchema = {
-	type: type$7,
-	properties: properties$6,
-	required: required$6,
-	additionalProperties: additionalProperties$6,
-	description: description$7
+	type: type$5,
+	properties: properties$5,
+	required: required$5,
+	additionalProperties: additionalProperties$5,
+	description: description$5
 };
 
-var type$6 = "object";
-var properties$5 = {
+var type$4 = "object";
+var properties$4 = {
 	id: {
 		type: "string",
 		description: "The id of the element."
@@ -321,25 +240,25 @@ var properties$5 = {
 		description: "The relationship between the two vertices."
 	}
 };
-var required$5 = [
+var required$4 = [
 	"@context",
 	"dateCreated",
 	"edgeRelationship",
 	"id",
 	"type"
 ];
-var additionalProperties$5 = false;
-var description$6 = "Interface describing an edge between two vertices in an auditable item graph.";
+var additionalProperties$4 = false;
+var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
 var AuditableItemGraphEdgeSchema = {
-	type: type$6,
-	properties: properties$5,
-	required: required$5,
-	additionalProperties: additionalProperties$5,
-	description: description$6
+	type: type$4,
+	properties: properties$4,
+	required: required$4,
+	additionalProperties: additionalProperties$4,
+	description: description$4
 };
 
-var type$5 = "object";
-var properties$4 = {
+var type$3 = "object";
+var properties$3 = {
 	"@context": {
 		anyOf: [
 			{
@@ -391,24 +310,24 @@ var properties$4 = {
 		description: "The value to add."
 	}
 };
-var required$4 = [
+var required$3 = [
 	"@context",
 	"type",
 	"patchOperation",
 	"patchPath"
 ];
-var additionalProperties$4 = false;
-var description$5 = "The patch operation for JSON diffs.";
+var additionalProperties$3 = false;
+var description$3 = "The patch operation for JSON diffs.";
 var AuditableItemGraphPatchOperationSchema = {
-	type: type$5,
-	properties: properties$4,
-	required: required$4,
-	additionalProperties: additionalProperties$4,
-	description: description$5
+	type: type$3,
+	properties: properties$3,
+	required: required$3,
+	additionalProperties: additionalProperties$3,
+	description: description$3
 };
 
-var type$4 = "object";
-var properties$3 = {
+var type$2 = "object";
+var properties$2 = {
 	id: {
 		type: "string",
 		description: "The id of the element."
@@ -457,95 +376,19 @@ var properties$3 = {
 		description: "The JSON-LD object for the resource."
 	}
 };
-var required$3 = [
+var required$2 = [
 	"@context",
 	"dateCreated",
 	"id",
 	"type"
 ];
-var additionalProperties$3 = false;
-var description$4 = "Interface describing an auditable item graph vertex resource.";
-var AuditableItemGraphResourceSchema = {
-	type: type$4,
-	properties: properties$3,
-	required: required$3,
-	additionalProperties: additionalProperties$3,
-	description: description$4
-};
-
-var type$3 = "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: {
-					type: "string"
-				}
-			}
-		],
-		description: "JSON-LD Context."
-	},
-	type: {
-		type: "string",
-		"const": "AuditableItemGraphVerification",
-		description: "JSON-LD Type."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time of the verification."
-	},
-	state: {
-		$ref: "https://schema.twindev.org/aig/AuditableItemGraphVerificationState",
-		description: "The state of the verification."
-	},
-	stateProperties: {
-		type: "object",
-		additionalProperties: {
-		},
-		description: "The state properties."
-	}
-};
-var required$2 = [
-	"@context",
-	"type",
-	"dateCreated",
-	"state"
-];
 var additionalProperties$2 = false;
-var description$3 = "Interface describing an auditable item graph verification.";
-var AuditableItemGraphVerificationSchema = {
-	type: type$3,
+var description$2 = "Interface describing an auditable item graph vertex resource.";
+var AuditableItemGraphResourceSchema = {
+	type: type$2,
 	properties: properties$2,
 	required: required$2,
 	additionalProperties: additionalProperties$2,
-	description: description$3
-};
-
-var type$2 = "string";
-var description$2 = "The state of the verification.";
-var AuditableItemGraphVerificationStateSchema = {
-	type: type$2,
-	"enum": [
-	"ok",
-	"hashMismatch",
-	"signatureNotVerified",
-	"credentialRevoked",
-	"immutableHashMismatch",
-	"immutableSignatureMismatch",
-	"integrityDataMismatch"
-],
 	description: description$2
 };
 
@@ -633,13 +476,6 @@ var properties$1 = {
 	verified: {
 		type: "boolean",
 		description: "Is the vertex verified, will only be populated when verification is requested."
-	},
-	changesetsVerification: {
-		type: "array",
-		items: {
-			$ref: "https://schema.twindev.org/aig/AuditableItemGraphVerification"
-		},
-		description: "The verification state of the changesets, will only be populated when changesets are requested."
 	}
 };
 var required$1 = [
@@ -754,66 +590,14 @@ class AuditableItemGraphDataTypes {
             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.VertexList, () => ({
             type: AuditableItemGraphTypes.VertexList,
             defaultValue: {},
             jsonSchema: async () => AuditableItemGraphVertexListSchema
         }));
-        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.
- */
-// 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",
-    /**
-     * Immutable signature mismatch.
-     */
-    ImmutableSignatureMismatch: "immutableSignatureMismatch",
-    /**
-     * Integrity data mismatch.
-     */
-    IntegrityDataMismatch: "integrityDataMismatch"
-};
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -835,4 +619,4 @@ const VerifyDepth = {
     All: "all"
 };
 
-export { AuditableItemGraphDataTypes, AuditableItemGraphTypes, AuditableItemGraphVerificationState, VerifyDepth };
+export { AuditableItemGraphDataTypes, AuditableItemGraphTypes, VerifyDepth };

package/dist/types/index.d.ts

@@ -6,16 +6,13 @@ export * from "./models/api/IAuditableItemGraphListRequest";
 export * from "./models/api/IAuditableItemGraphListResponse";
 export * from "./models/api/IAuditableItemGraphUpdateRequest";
 export * from "./models/auditableItemGraphTypes";
-export * from "./models/auditableItemGraphVerificationState";
 export * from "./models/IAuditableItemGraphAlias";
 export * from "./models/IAuditableItemGraphAuditedElement";
 export * from "./models/IAuditableItemGraphChangeset";
 export * from "./models/IAuditableItemGraphComponent";
-export * from "./models/IAuditableItemGraphCredential";
 export * from "./models/IAuditableItemGraphEdge";
 export * from "./models/IAuditableItemGraphPatchOperation";
 export * from "./models/IAuditableItemGraphResource";
-export * from "./models/IAuditableItemGraphVerification";
 export * from "./models/IAuditableItemGraphVertex";
 export * from "./models/IAuditableItemGraphVertexList";
 export * from "./models/verifyDepth";

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

@@ -1,3 +1,4 @@
+import type { IImmutableProofVerification } from "@twin.org/immutable-proof-models";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphPatchOperation } from "./IAuditableItemGraphPatchOperation";
 /**
@@ -12,6 +13,10 @@ export interface IAuditableItemGraphChangeset {
      * JSON-LD Type.
      */
     type: typeof AuditableItemGraphTypes.Changeset;
+    /**
+     * The id of the changeset.
+     */
+    id: string;
     /**
      * The date/time of when the changeset was created.
      */
@@ -25,15 +30,11 @@ export interface IAuditableItemGraphChangeset {
      */
     patches: IAuditableItemGraphPatchOperation[];
     /**
-     * The hash for the changeset.
-     */
-    hash: string;
-    /**
-     * The signature for the changeset.
+     * The immutable proof id which contains the signature for this changeset.
      */
-    signature: string;
+    proofId?: string;
     /**
-     * The immutable storage id containing the signature for the changeset.
+     * The verification for the changeset.
      */
-    immutableStorageId?: string;
+    verification?: IImmutableProofVerification;
 }

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

@@ -5,7 +5,6 @@ import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAud
 import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset";
 import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge";
 import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource";
-import type { IAuditableItemGraphVerification } from "./IAuditableItemGraphVerification";
 /**
  * Interface describing an auditable item graph vertex.
  */
@@ -46,8 +45,4 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
      * Is the vertex verified, will only be populated when verification is requested.
      */
     verified?: boolean;
-    /**
-     * The verification state of the changesets, will only be populated when changesets are requested.
-     */
-    changesetsVerification?: IAuditableItemGraphVerification[];
 }

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

@@ -30,18 +30,6 @@ export declare const AuditableItemGraphTypes: {
      * Represents patch operation.
      */
     readonly PatchOperation: "AuditableItemGraphPatchOperation";
-    /**
-     * Represents the immutable credential payload.
-     */
-    readonly Credential: "AuditableItemGraphPatchCredential";
-    /**
-     * Represents auditable item stream verification.
-     */
-    readonly Verification: "AuditableItemGraphVerification";
-    /**
-     * Represents auditable item stream verification state.
-     */
-    readonly VerificationState: "AuditableItemGraphVerificationState";
     /**
      * Represents auditable item stream vertex list.
      */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/auditable-item-graph-models - Changelog
 
-## v0.0.1-next.7
+## v0.0.1-next.9
 
 - Initial Release

package/docs/reference/index.md

@@ -10,11 +10,9 @@
 - [IAuditableItemGraphAuditedElement](interfaces/IAuditableItemGraphAuditedElement.md)
 - [IAuditableItemGraphChangeset](interfaces/IAuditableItemGraphChangeset.md)
 - [IAuditableItemGraphComponent](interfaces/IAuditableItemGraphComponent.md)
-- [IAuditableItemGraphCredential](interfaces/IAuditableItemGraphCredential.md)
 - [IAuditableItemGraphEdge](interfaces/IAuditableItemGraphEdge.md)
 - [IAuditableItemGraphPatchOperation](interfaces/IAuditableItemGraphPatchOperation.md)
 - [IAuditableItemGraphResource](interfaces/IAuditableItemGraphResource.md)
-- [IAuditableItemGraphVerification](interfaces/IAuditableItemGraphVerification.md)
 - [IAuditableItemGraphVertex](interfaces/IAuditableItemGraphVertex.md)
 - [IAuditableItemGraphVertexList](interfaces/IAuditableItemGraphVertexList.md)
 - [IAuditableItemGraphCreateRequest](interfaces/IAuditableItemGraphCreateRequest.md)
@@ -27,11 +25,9 @@
 ## Type Aliases
 
 - [AuditableItemGraphTypes](type-aliases/AuditableItemGraphTypes.md)
-- [AuditableItemGraphVerificationState](type-aliases/AuditableItemGraphVerificationState.md)
 - [VerifyDepth](type-aliases/VerifyDepth.md)
 
 ## Variables
 
 - [AuditableItemGraphTypes](variables/AuditableItemGraphTypes.md)
-- [AuditableItemGraphVerificationState](variables/AuditableItemGraphVerificationState.md)
 - [VerifyDepth](variables/VerifyDepth.md)

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -20,6 +20,14 @@ JSON-LD Type.
 
 ***
 
+### id
+
+> **id**: `string`
+
+The id of the changeset.
+
+***
+
 ### dateCreated
 
 > **dateCreated**: `string`
@@ -44,24 +52,16 @@ The patches in the changeset.
 
 ***
 
-### hash
-
-> **hash**: `string`
-
-The hash for the changeset.
-
-***
-
-### signature
+### proofId?
 
-> **signature**: `string`
+> `optional` **proofId**: `string`
 
-The signature for the changeset.
+The immutable proof id which contains the signature for this changeset.
 
 ***
 
-### immutableStorageId?
+### verification?
 
-> `optional` **immutableStorageId**: `string`
+> `optional` **verification**: `IImmutableProofVerification`
 
-The immutable storage id containing the signature for the changeset.
+The verification for the changeset.

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -125,11 +125,3 @@ Changesets for the vertex.
 > `optional` **verified**: `boolean`
 
 Is the vertex verified, will only be populated when verification is requested.
-
-***
-
-### changesetsVerification?
-
-> `optional` **changesetsVerification**: [`IAuditableItemGraphVerification`](IAuditableItemGraphVerification.md)[]
-
-The verification state of the changesets, will only be populated when changesets are requested.

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -48,24 +48,6 @@ Represents auditable item graph  changeset.
 
 Represents patch operation.
 
-### Credential
-
-> `readonly` **Credential**: `"AuditableItemGraphPatchCredential"` = `"AuditableItemGraphPatchCredential"`
-
-Represents the immutable credential payload.
-
-### Verification
-
-> `readonly` **Verification**: `"AuditableItemGraphVerification"` = `"AuditableItemGraphVerification"`
-
-Represents auditable item stream verification.
-
-### VerificationState
-
-> `readonly` **VerificationState**: `"AuditableItemGraphVerificationState"` = `"AuditableItemGraphVerificationState"`
-
-Represents auditable item stream verification state.
-
 ### VertexList
 
 > `readonly` **VertexList**: `"AuditableItemGraphVertexList"` = `"AuditableItemGraphVertexList"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.1-next.7",
+	"version": "0.0.1-next.9",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",
@@ -18,6 +18,7 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
+		"@twin.org/immutable-proof-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},