@twin.org/immutable-proof-models 0.0.1-next.2 → 0.0.1-next.21

package/dist/cjs/index.cjs

@@ -13,6 +13,10 @@ const ImmutableProofTypes = {
      * 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/",
     /**
      * Represents Immutable Proof.
      */
@@ -26,25 +30,21 @@ const ImmutableProofTypes = {
 var type = "object";
 var properties = {
 	"@context": {
-		anyOf: [
+		type: "array",
+		minItems: 2,
+		items: [
 			{
 				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/"
 			}
 		],
+		additionalItems: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
 		description: "JSON-LD Context."
 	},
 	type: {
@@ -71,6 +71,10 @@ var properties = {
 	proof: {
 		$ref: "https://schema.twindev.org/did/DidProof",
 		description: "The proof which can be undefined if it has not yet been issued."
+	},
+	immutableReceipt: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The immutable receipt detail for where the proof is stored."
 	}
 };
 var required = [
@@ -137,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

@@ -11,6 +11,10 @@ const ImmutableProofTypes = {
      * 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/",
     /**
      * Represents Immutable Proof.
      */
@@ -24,25 +28,21 @@ const ImmutableProofTypes = {
 var type = "object";
 var properties = {
 	"@context": {
-		anyOf: [
+		type: "array",
+		minItems: 2,
+		items: [
 			{
 				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/"
 			}
 		],
+		additionalItems: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
 		description: "JSON-LD Context."
 	},
 	type: {
@@ -69,6 +69,10 @@ var properties = {
 	proof: {
 		$ref: "https://schema.twindev.org/did/DidProof",
 		description: "The proof which can be undefined if it has not yet been issued."
+	},
+	immutableReceipt: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The immutable receipt detail for where the proof is stored."
 	}
 };
 var required = [
@@ -135,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/IImmutableProof.d.ts

@@ -1,3 +1,4 @@
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IDidProof } from "@twin.org/standards-w3c-did";
 import type { ImmutableProofTypes } from "./immutableProofTypes";
 /**
@@ -7,7 +8,11 @@ export interface IImmutableProof {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof ImmutableProofTypes.ContextRoot | [typeof ImmutableProofTypes.ContextRoot, ...string[]];
+    "@context": [
+        typeof ImmutableProofTypes.ContextRoot,
+        typeof ImmutableProofTypes.ContextRootCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
     /**
      * JSON-LD Type.
      */
@@ -32,4 +37,8 @@ export interface IImmutableProof {
      * The proof which can be undefined if it has not yet been issued.
      */
     proof?: IDidProof;
+    /**
+     * The immutable receipt detail for where the proof is stored.
+     */
+    immutableReceipt?: IJsonLdNodeObject;
 }

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

@@ -24,11 +24,10 @@ export interface IImmutableProofComponent extends IComponent {
     /**
      * Verify an authentication 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.
      * @param id The id of the proof to remove the storage from.

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/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

@@ -6,6 +6,10 @@ export declare const ImmutableProofTypes: {
      * 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/";
     /**
      * Represents Immutable Proof.
      */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/immutable-proof-models - Changelog
 
-## v0.0.1-next.2
+## v0.0.1-next.21
 
 - 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/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -57,3 +57,11 @@ The hash of the object associated with the proof.
 > `optional` **proof**: `IDidProof`
 
 The proof which can be undefined if it has not yet been issued.
+
+***
+
+### immutableReceipt?
+
+> `optional` **immutableReceipt**: `IJsonLdNodeObject`
+
+The immutable receipt detail for where the proof is stored.

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.
 
@@ -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.
 
 #### 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
 
@@ -96,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/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/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/docs/reference/variables/ImmutableProofTypes.md

@@ -12,6 +12,12 @@ The types of immutable proof data.
 
 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.
+
 ### ImmutableProof
 
 > `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-models",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.21",
 	"description": "Models which define the structure of the immutable proof connectors and services",
 	"repository": {
 		"type": "git",
@@ -27,11 +27,11 @@
 	"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": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",