@twin.org/immutable-proof-models 0.0.1-next.9 → 0.0.2-next.1

package/dist/cjs/index.cjs

@@ -5,14 +5,27 @@ var dataCore = require('@twin.org/data-core');
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The types of immutable proof data.
+ * The contexts of immutable proof data.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const ImmutableProofTypes = {
+const ImmutableProofContexts = {
     /**
      * The context root for the immutable proof types.
      */
     ContextRoot: "https://schema.twindev.org/immutable-proof/",
+    /**
+     * 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 immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofTypes = {
     /**
      * Represents Immutable Proof.
      */
@@ -23,29 +36,28 @@ const ImmutableProofTypes = {
     ImmutableProofVerification: "ImmutableProofVerification"
 };
 
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/immutable-proof/ImmutableProof";
+var description = "Interface describing an immutable proof state.";
 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/immutable-proof/"
 			},
 			{
-				type: "array",
-				minItems: 1,
-				items: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/immutable-proof/"
-					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
 			}
-		],
-		description: "JSON-LD Context."
+		]
 	},
 	type: {
 		type: "string",
@@ -56,6 +68,10 @@ var properties = {
 		type: "string",
 		description: "The id of the proof."
 	},
+	nodeIdentity: {
+		type: "string",
+		description: "The id of the node who created the proof."
+	},
 	userIdentity: {
 		type: "string",
 		description: "The id of the user who created the proof."
@@ -68,8 +84,12 @@ var properties = {
 		type: "string",
 		description: "The hash of the object associated with the proof."
 	},
+	verifiableStorageId: {
+		type: "string",
+		description: "The verifiable storage id for where the proof is stored."
+	},
 	proof: {
-		$ref: "https://schema.twindev.org/did/DidProof",
+		$ref: "https://schema.twindev.org/w3c-did/DataIntegrityProof",
 		description: "The proof which can be undefined if it has not yet been issued."
 	},
 	immutableReceipt: {
@@ -81,17 +101,19 @@ var required = [
 	"@context",
 	"type",
 	"id",
+	"nodeIdentity",
 	"userIdentity",
 	"proofObjectHash"
 ];
 var additionalProperties = false;
-var description = "Interface describing an immutable proof state.";
 var ImmutableProofSchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
 	type: type,
 	properties: properties,
 	required: required,
-	additionalProperties: additionalProperties,
-	description: description
+	additionalProperties: additionalProperties
 };
 
 // Copyright 2024 IOTA Stiftung.
@@ -104,7 +126,8 @@ class ImmutableProofDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        dataCore.DataTypeHandlerFactory.register(ImmutableProofTypes.ImmutableProof, () => ({
+        dataCore.DataTypeHandlerFactory.register(`${ImmutableProofContexts.ContextRoot}${ImmutableProofTypes.ImmutableProof}`, () => ({
+            context: ImmutableProofContexts.ContextRoot,
             type: ImmutableProofTypes.ImmutableProof,
             defaultValue: {},
             jsonSchema: async () => ImmutableProofSchema
@@ -120,7 +143,7 @@ class ImmutableProofDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const ImmutableProofFailure = {
     /**
-     * Proof not yes issued.
+     * Proof not yet issued.
      */
     NotIssued: "notIssued",
     /**
@@ -141,6 +164,21 @@ const ImmutableProofFailure = {
     SignatureMismatch: "signatureMismatch"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The topics for immutable proof event bus notifications.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofTopics = {
+    /**
+     * A proof was created.
+     */
+    ProofCreated: "immutable-proof:proof-created"
+};
+
+exports.ImmutableProofContexts = ImmutableProofContexts;
 exports.ImmutableProofDataTypes = ImmutableProofDataTypes;
 exports.ImmutableProofFailure = ImmutableProofFailure;
+exports.ImmutableProofTopics = ImmutableProofTopics;
 exports.ImmutableProofTypes = ImmutableProofTypes;

package/dist/esm/index.mjs

@@ -3,14 +3,27 @@ import { DataTypeHandlerFactory } from '@twin.org/data-core';
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The types of immutable proof data.
+ * The contexts of immutable proof data.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const ImmutableProofTypes = {
+const ImmutableProofContexts = {
     /**
      * The context root for the immutable proof types.
      */
     ContextRoot: "https://schema.twindev.org/immutable-proof/",
+    /**
+     * 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 immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofTypes = {
     /**
      * Represents Immutable Proof.
      */
@@ -21,29 +34,28 @@ const ImmutableProofTypes = {
     ImmutableProofVerification: "ImmutableProofVerification"
 };
 
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/immutable-proof/ImmutableProof";
+var description = "Interface describing an immutable proof state.";
 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/immutable-proof/"
 			},
 			{
-				type: "array",
-				minItems: 1,
-				items: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/immutable-proof/"
-					}
-				],
-				additionalItems: {
-					type: "string"
-				}
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
 			}
-		],
-		description: "JSON-LD Context."
+		]
 	},
 	type: {
 		type: "string",
@@ -54,6 +66,10 @@ var properties = {
 		type: "string",
 		description: "The id of the proof."
 	},
+	nodeIdentity: {
+		type: "string",
+		description: "The id of the node who created the proof."
+	},
 	userIdentity: {
 		type: "string",
 		description: "The id of the user who created the proof."
@@ -66,8 +82,12 @@ var properties = {
 		type: "string",
 		description: "The hash of the object associated with the proof."
 	},
+	verifiableStorageId: {
+		type: "string",
+		description: "The verifiable storage id for where the proof is stored."
+	},
 	proof: {
-		$ref: "https://schema.twindev.org/did/DidProof",
+		$ref: "https://schema.twindev.org/w3c-did/DataIntegrityProof",
 		description: "The proof which can be undefined if it has not yet been issued."
 	},
 	immutableReceipt: {
@@ -79,17 +99,19 @@ var required = [
 	"@context",
 	"type",
 	"id",
+	"nodeIdentity",
 	"userIdentity",
 	"proofObjectHash"
 ];
 var additionalProperties = false;
-var description = "Interface describing an immutable proof state.";
 var ImmutableProofSchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
 	type: type,
 	properties: properties,
 	required: required,
-	additionalProperties: additionalProperties,
-	description: description
+	additionalProperties: additionalProperties
 };
 
 // Copyright 2024 IOTA Stiftung.
@@ -102,7 +124,8 @@ class ImmutableProofDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        DataTypeHandlerFactory.register(ImmutableProofTypes.ImmutableProof, () => ({
+        DataTypeHandlerFactory.register(`${ImmutableProofContexts.ContextRoot}${ImmutableProofTypes.ImmutableProof}`, () => ({
+            context: ImmutableProofContexts.ContextRoot,
             type: ImmutableProofTypes.ImmutableProof,
             defaultValue: {},
             jsonSchema: async () => ImmutableProofSchema
@@ -118,7 +141,7 @@ class ImmutableProofDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const ImmutableProofFailure = {
     /**
-     * Proof not yes issued.
+     * Proof not yet issued.
      */
     NotIssued: "notIssued",
     /**
@@ -139,4 +162,17 @@ const ImmutableProofFailure = {
     SignatureMismatch: "signatureMismatch"
 };
 
-export { ImmutableProofDataTypes, ImmutableProofFailure, ImmutableProofTypes };
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The topics for immutable proof event bus notifications.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofTopics = {
+    /**
+     * A proof was created.
+     */
+    ProofCreated: "immutable-proof:proof-created"
+};
+
+export { ImmutableProofContexts, ImmutableProofDataTypes, ImmutableProofFailure, ImmutableProofTopics, ImmutableProofTypes };

package/dist/types/index.d.ts

@@ -4,8 +4,11 @@ export * from "./models/api/IImmutableProofGetRequest";
 export * from "./models/api/IImmutableProofGetResponse";
 export * from "./models/api/IImmutableProofVerifyRequest";
 export * from "./models/api/IImmutableProofVerifyResponse";
+export * from "./models/eventBus/IImmutableProofEventBusProofCreated";
 export * from "./models/IImmutableProof";
-export * from "./models/IImmutableProofVerification";
 export * from "./models/IImmutableProofComponent";
+export * from "./models/IImmutableProofVerification";
+export * from "./models/immutableProofContexts";
 export * from "./models/immutableProofFailure";
+export * from "./models/immutableProofTopics";
 export * from "./models/immutableProofTypes";

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

@@ -1,5 +1,6 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IDidProof } from "@twin.org/standards-w3c-did";
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IDataIntegrityProof } from "@twin.org/standards-w3c-did";
+import type { ImmutableProofContexts } from "./immutableProofContexts";
 import type { ImmutableProofTypes } from "./immutableProofTypes";
 /**
  * Interface describing an immutable proof state.
@@ -8,7 +9,11 @@ export interface IImmutableProof {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof ImmutableProofTypes.ContextRoot | [typeof ImmutableProofTypes.ContextRoot, ...string[]];
+    "@context": [
+        typeof ImmutableProofContexts.ContextRoot,
+        typeof ImmutableProofContexts.ContextRootCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
     /**
      * JSON-LD Type.
      */
@@ -17,6 +22,10 @@ export interface IImmutableProof {
      * The id of the proof.
      */
     id: string;
+    /**
+     * The id of the node who created the proof.
+     */
+    nodeIdentity: string;
     /**
      * The id of the user who created the proof.
      */
@@ -29,10 +38,14 @@ export interface IImmutableProof {
      * The hash of the object associated with the proof.
      */
     proofObjectHash: string;
+    /**
+     * The verifiable storage id for where the proof is stored.
+     */
+    verifiableStorageId?: string;
     /**
      * The proof which can be undefined if it has not yet been issued.
      */
-    proof?: IDidProof;
+    proof?: IDataIntegrityProof;
     /**
      * The immutable receipt detail for where the proof is stored.
      */

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

@@ -7,34 +7,33 @@ import type { IImmutableProofVerification } from "./IImmutableProofVerification"
  */
 export interface IImmutableProofComponent extends IComponent {
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
+     * Create a new proof.
+     * @param document The document to create the proof for.
      * @param userIdentity The identity to create the immutable proof operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The id of the new authentication proof.
+     * @returns The id of the new proof.
      */
-    create(proofObject: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(document: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
-     * Get an authentication proof.
+     * Get a proof.
      * @param id The id of the proof to get.
      * @returns The proof.
      * @throws NotFoundError if the proof is not found.
      */
     get(id: string): Promise<IImmutableProof>;
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    verify(id: string, proofObject: IJsonLdNodeObject): Promise<IImmutableProofVerification>;
+    verify(id: string): Promise<IImmutableProofVerification>;
     /**
-     * Remove the immutable storage for the proof.
+     * Remove the verifiable storage for the proof.
      * @param id The id of the proof to remove the storage from.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the proof is not found.
      */
-    removeImmutable(id: string, nodeIdentity?: string): Promise<void>;
+    removeVerifiable(id: string, nodeIdentity?: string): Promise<void>;
 }

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

@@ -1,3 +1,4 @@
+import type { ImmutableProofContexts } from "./immutableProofContexts";
 import type { ImmutableProofFailure } from "./immutableProofFailure";
 import type { ImmutableProofTypes } from "./immutableProofTypes";
 /**
@@ -7,7 +8,7 @@ export interface IImmutableProofVerification {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof ImmutableProofTypes.ContextRoot;
+    "@context": typeof ImmutableProofContexts.ContextRoot;
     /**
      * JSON-LD Type.
      */

package/dist/types/models/api/IImmutableProofCreateRequest.d.ts

@@ -8,8 +8,8 @@ export interface IImmutableProofCreateRequest {
      */
     body: {
         /**
-         * The proof object to create the proof for.
+         * The document to create the proof for.
          */
-        proofObject: IJsonLdNodeObject;
+        document: IJsonLdNodeObject;
     };
 }

package/dist/types/models/api/IImmutableProofVerifyRequest.d.ts

@@ -1,4 +1,3 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * Verify a proof.
@@ -19,13 +18,4 @@ export interface IImmutableProofVerifyRequest {
          */
         id: string;
     };
-    /**
-     * The parameters from the body.
-     */
-    body: {
-        /**
-         * The proof object to verify.
-         */
-        proofObject: IJsonLdNodeObject;
-    };
 }

package/dist/types/models/eventBus/IImmutableProofEventBusProofCreated.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Event bus payload for proof created.
+ */
+export interface IImmutableProofEventBusProofCreated {
+    /**
+     * The id of the proof created.
+     */
+    id: string;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts of immutable proof data.
+ */
+export declare const ImmutableProofContexts: {
+    /**
+     * The context root for the immutable proof types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/immutable-proof/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of immutable proof data.
+ */
+export type ImmutableProofContexts = (typeof ImmutableProofContexts)[keyof typeof ImmutableProofContexts];

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

@@ -3,7 +3,7 @@
  */
 export declare const ImmutableProofFailure: {
     /**
-     * Proof not yes issued.
+     * Proof not yet issued.
      */
     readonly NotIssued: "notIssued";
     /**

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

@@ -0,0 +1,13 @@
+/**
+ * The topics for immutable proof event bus notifications.
+ */
+export declare const ImmutableProofTopics: {
+    /**
+     * A proof was created.
+     */
+    readonly ProofCreated: "immutable-proof:proof-created";
+};
+/**
+ * The topics for immutable proof event bus notifications.
+ */
+export type ImmutableProofTopics = (typeof ImmutableProofTopics)[keyof typeof ImmutableProofTopics];

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

@@ -2,10 +2,6 @@
  * The types of immutable proof data.
  */
 export declare const ImmutableProofTypes: {
-    /**
-     * The context root for the immutable proof types.
-     */
-    readonly ContextRoot: "https://schema.twindev.org/immutable-proof/";
     /**
      * Represents Immutable Proof.
      */

package/docs/changelog.md

@@ -1,5 +1,64 @@
 # @twin.org/immutable-proof-models - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.2-next.0...immutable-proof-models-v0.0.2-next.1) (2025-08-20)
+
+
+### Features
+
+* update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
+* update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
+* update framework core ([e708d4d](https://github.com/twinfoundation/immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
+* update ts-to-schema generation ([c4fc864](https://github.com/twinfoundation/immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
+* update twindev schemas ([d2bb94b](https://github.com/twinfoundation/immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
+* use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
+
+
+### Bug Fixes
+
+* Missing user and node identity on create ([#1](https://github.com/twinfoundation/immutable-proof/issues/1)) ([80ea2f9](https://github.com/twinfoundation/immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
+
+## 0.0.1 (2025-07-09)
+
+
+### Features
+
+* release to production ([cb7ecff](https://github.com/twinfoundation/immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
+
+## [0.0.1-next.35](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.34...immutable-proof-models-v0.0.1-next.35) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
+
+## [0.0.1-next.34](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.33...immutable-proof-models-v0.0.1-next.34) (2025-06-03)
+
+
+### Features
+
+* update ts-to-schema generation ([c4fc864](https://github.com/twinfoundation/immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
+
+## [0.0.1-next.33](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.32...immutable-proof-models-v0.0.1-next.33) (2025-05-28)
+
+
+### Features
+
+* update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
+
+## [0.0.1-next.32](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.31...immutable-proof-models-v0.0.1-next.32) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
+
+## [0.0.1-next.31](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.30...immutable-proof-models-v0.0.1-next.31) (2025-03-28)
+
+
+### Bug Fixes
+
+* Missing user and node identity on create ([#1](https://github.com/twinfoundation/immutable-proof/issues/1)) ([80ea2f9](https://github.com/twinfoundation/immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
+
+## v0.0.1-next.30
 
 - Initial Release

package/docs/reference/classes/ImmutableProofDataTypes.md

@@ -4,13 +4,13 @@ Handle all the data types for immutable proof.
 
 ## Constructors
 
-### new ImmutableProofDataTypes()
+### Constructor
 
-> **new ImmutableProofDataTypes**(): [`ImmutableProofDataTypes`](ImmutableProofDataTypes.md)
+> **new ImmutableProofDataTypes**(): `ImmutableProofDataTypes`
 
 #### Returns
 
-[`ImmutableProofDataTypes`](ImmutableProofDataTypes.md)
+`ImmutableProofDataTypes`
 
 ## Methods
 

package/docs/reference/index.md

@@ -14,13 +14,18 @@
 - [IImmutableProofGetResponse](interfaces/IImmutableProofGetResponse.md)
 - [IImmutableProofVerifyRequest](interfaces/IImmutableProofVerifyRequest.md)
 - [IImmutableProofVerifyResponse](interfaces/IImmutableProofVerifyResponse.md)
+- [IImmutableProofEventBusProofCreated](interfaces/IImmutableProofEventBusProofCreated.md)
 
 ## Type Aliases
 
+- [ImmutableProofContexts](type-aliases/ImmutableProofContexts.md)
 - [ImmutableProofFailure](type-aliases/ImmutableProofFailure.md)
+- [ImmutableProofTopics](type-aliases/ImmutableProofTopics.md)
 - [ImmutableProofTypes](type-aliases/ImmutableProofTypes.md)
 
 ## Variables
 
+- [ImmutableProofContexts](variables/ImmutableProofContexts.md)
 - [ImmutableProofFailure](variables/ImmutableProofFailure.md)
+- [ImmutableProofTopics](variables/ImmutableProofTopics.md)
 - [ImmutableProofTypes](variables/ImmutableProofTypes.md)

package/docs/reference/interfaces/IImmutableProof.md

@@ -6,7 +6,7 @@ Interface describing an immutable proof state.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/immutable-proof/"` \| [`"https://schema.twindev.org/immutable-proof/"`, `...string[]`]
+> **@context**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -28,6 +28,14 @@ The id of the proof.
 
 ***
 
+### nodeIdentity
+
+> **nodeIdentity**: `string`
+
+The id of the node who created the proof.
+
+***
+
 ### userIdentity
 
 > **userIdentity**: `string`
@@ -52,9 +60,17 @@ The hash of the object associated with the proof.
 
 ***
 
+### verifiableStorageId?
+
+> `optional` **verifiableStorageId**: `string`
+
+The verifiable storage id for where the proof is stored.
+
+***
+
 ### proof?
 
-> `optional` **proof**: `IDidProof`
+> `optional` **proof**: `IDataIntegrityProof`
 
 The proof which can be undefined if it has not yet been issued.
 

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -10,21 +10,27 @@ Interface describing an immutable proof contract.
 
 ### create()
 
-> **create**(`proofObject`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`document`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
-Create a new authentication proof.
+Create a new proof.
 
 #### Parameters
 
-• **proofObject**: `IJsonLdNodeObject`
+##### document
 
-The object for the proof as JSON-LD.
+`IJsonLdNodeObject`
 
-• **userIdentity?**: `string`
+The document to create the proof for.
+
+##### userIdentity?
+
+`string`
 
 The identity to create the immutable proof operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -32,7 +38,7 @@ The node identity to use for vault operations.
 
 `Promise`\<`string`\>
 
-The id of the new authentication proof.
+The id of the new proof.
 
 ***
 
@@ -40,11 +46,13 @@ The id of the new authentication proof.
 
 > **get**(`id`): `Promise`\<[`IImmutableProof`](IImmutableProof.md)\>
 
-Get an authentication proof.
+Get a proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to get.
 
@@ -62,19 +70,17 @@ NotFoundError if the proof is not found.
 
 ### verify()
 
-> **verify**(`id`, `proofObject`): `Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
+> **verify**(`id`): `Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
 
-Verify an authentication proof.
+Verify a proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
 
-The id of the proof to verify.
+`string`
 
-• **proofObject**: `IJsonLdNodeObject`
-
-The object to verify as JSON-LD.
+The id of the proof to verify.
 
 #### Returns
 
@@ -88,19 +94,23 @@ NotFoundError if the proof is not found.
 
 ***
 
-### removeImmutable()
+### removeVerifiable()
 
-> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Remove the immutable storage for the proof.
+Remove the verifiable storage for the proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to remove the storage from.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 

package/docs/reference/interfaces/IImmutableProofCreateRequest.md

@@ -10,8 +10,8 @@ Create a proof.
 
 The parameters from the body.
 
-#### proofObject
+#### document
 
-> **proofObject**: `IJsonLdNodeObject`
+> **document**: `IJsonLdNodeObject`
 
-The proof object to create the proof for.
+The document to create the proof for.

package/docs/reference/interfaces/IImmutableProofEventBusProofCreated.md

@@ -0,0 +1,11 @@
+# Interface: IImmutableProofEventBusProofCreated
+
+Event bus payload for proof created.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id of the proof created.

package/docs/reference/interfaces/IImmutableProofVerifyRequest.md

@@ -27,17 +27,3 @@ The parameters from the path.
 > **id**: `string`
 
 The id of the immutable proof to verify.
-
-***
-
-### body
-
-> **body**: `object`
-
-The parameters from the body.
-
-#### proofObject
-
-> **proofObject**: `IJsonLdNodeObject`
-
-The proof object to verify.

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

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofContexts
+
+> **ImmutableProofContexts** = *typeof* [`ImmutableProofContexts`](../variables/ImmutableProofContexts.md)\[keyof *typeof* [`ImmutableProofContexts`](../variables/ImmutableProofContexts.md)\]
+
+The contexts of immutable proof data.

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

@@ -1,5 +1,5 @@
 # Type Alias: ImmutableProofFailure
 
-> **ImmutableProofFailure**: *typeof* [`ImmutableProofFailure`](../variables/ImmutableProofFailure.md)\[keyof *typeof* [`ImmutableProofFailure`](../variables/ImmutableProofFailure.md)\]
+> **ImmutableProofFailure** = *typeof* [`ImmutableProofFailure`](../variables/ImmutableProofFailure.md)\[keyof *typeof* [`ImmutableProofFailure`](../variables/ImmutableProofFailure.md)\]
 
 The failure reason of the proof.

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

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofTopics
+
+> **ImmutableProofTopics** = *typeof* [`ImmutableProofTopics`](../variables/ImmutableProofTopics.md)\[keyof *typeof* [`ImmutableProofTopics`](../variables/ImmutableProofTopics.md)\]
+
+The topics for immutable proof event bus notifications.

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

@@ -1,5 +1,5 @@
 # Type Alias: ImmutableProofTypes
 
-> **ImmutableProofTypes**: *typeof* [`ImmutableProofTypes`](../variables/ImmutableProofTypes.md)\[keyof *typeof* [`ImmutableProofTypes`](../variables/ImmutableProofTypes.md)\]
+> **ImmutableProofTypes** = *typeof* [`ImmutableProofTypes`](../variables/ImmutableProofTypes.md)\[keyof *typeof* [`ImmutableProofTypes`](../variables/ImmutableProofTypes.md)\]
 
 The types of immutable proof data.

package/docs/reference/variables/ImmutableProofContexts.md

@@ -0,0 +1,19 @@
+# Variable: ImmutableProofContexts
+
+> `const` **ImmutableProofContexts**: `object`
+
+The contexts of immutable proof data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
+
+The context root for the immutable proof types.
+
+### ContextRootCommon
+
+> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The context root for the common types.

package/docs/reference/variables/ImmutableProofFailure.md

@@ -10,7 +10,7 @@ The failure reason of the proof.
 
 > `readonly` **NotIssued**: `"notIssued"` = `"notIssued"`
 
-Proof not yes issued.
+Proof not yet issued.
 
 ### ProofMissing
 

package/docs/reference/variables/ImmutableProofTopics.md

@@ -0,0 +1,13 @@
+# Variable: ImmutableProofTopics
+
+> `const` **ImmutableProofTopics**: `object`
+
+The topics for immutable proof event bus notifications.
+
+## Type declaration
+
+### ProofCreated
+
+> `readonly` **ProofCreated**: `"immutable-proof:proof-created"` = `"immutable-proof:proof-created"`
+
+A proof was created.

package/docs/reference/variables/ImmutableProofTypes.md

@@ -6,12 +6,6 @@ The types of immutable proof data.
 
 ## Type declaration
 
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
-
-The context root for the immutable proof types.
-
 ### ImmutableProof
 
 > `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-models",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Models which define the structure of the immutable proof connectors and services",
 	"repository": {
 		"type": "git",
@@ -27,9 +27,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},