@twin.org/immutable-proof-models 0.0.1-next.13 → 0.0.1-next.15

package/dist/cjs/index.cjs

@@ -141,6 +141,20 @@ 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.ImmutableProofDataTypes = ImmutableProofDataTypes;
 exports.ImmutableProofFailure = ImmutableProofFailure;
+exports.ImmutableProofTopics = ImmutableProofTopics;
 exports.ImmutableProofTypes = ImmutableProofTypes;

package/dist/esm/index.mjs

@@ -139,4 +139,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 { ImmutableProofDataTypes, ImmutableProofFailure, ImmutableProofTopics, ImmutableProofTypes };

package/dist/types/index.d.ts

@@ -4,8 +4,10 @@ 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/immutableProofFailure";
+export * from "./models/immutableProofTopics";
 export * from "./models/immutableProofTypes";

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/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/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/immutable-proof-models - Changelog
 
-## v0.0.1-next.13
+## v0.0.1-next.15
 
 - Initial Release

package/docs/reference/index.md

@@ -14,13 +14,16 @@
 - [IImmutableProofGetResponse](interfaces/IImmutableProofGetResponse.md)
 - [IImmutableProofVerifyRequest](interfaces/IImmutableProofVerifyRequest.md)
 - [IImmutableProofVerifyResponse](interfaces/IImmutableProofVerifyResponse.md)
+- [IImmutableProofEventBusProofCreated](interfaces/IImmutableProofEventBusProofCreated.md)
 
 ## Type Aliases
 
 - [ImmutableProofFailure](type-aliases/ImmutableProofFailure.md)
+- [ImmutableProofTopics](type-aliases/ImmutableProofTopics.md)
 - [ImmutableProofTypes](type-aliases/ImmutableProofTypes.md)
 
 ## Variables
 
 - [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/immutable-proof/"`, `...string[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -16,15 +16,21 @@ Create a new authentication proof.
 
 #### Parameters
 
-• **proofObject**: `IJsonLdNodeObject`
+##### proofObject
+
+`IJsonLdNodeObject`
 
 The object for the proof as JSON-LD.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the immutable proof operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -44,7 +50,9 @@ Get an authentication proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to get.
 
@@ -68,7 +76,9 @@ Verify an authentication proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to verify.
 
@@ -92,11 +102,15 @@ Remove the immutable 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/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/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/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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-models",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.15",
 	"description": "Models which define the structure of the immutable proof connectors and services",
 	"repository": {
 		"type": "git",