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

package/dist/cjs/index.cjs

@@ -16,7 +16,11 @@ const ImmutableProofTypes = {
     /**
      * Represents Immutable Proof.
      */
-    ImmutableProof: "ImmutableProof"
+    ImmutableProof: "ImmutableProof",
+    /**
+     * Represents Immutable Proof Verification.
+     */
+    ImmutableProofVerification: "ImmutableProofVerification"
 };
 
 var type = "object";

package/dist/esm/index.mjs

@@ -14,7 +14,11 @@ const ImmutableProofTypes = {
     /**
      * Represents Immutable Proof.
      */
-    ImmutableProof: "ImmutableProof"
+    ImmutableProof: "ImmutableProof",
+    /**
+     * Represents Immutable Proof Verification.
+     */
+    ImmutableProofVerification: "ImmutableProofVerification"
 };
 
 var type = "object";

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export * from "./models/api/IImmutableProofGetResponse";
 export * from "./models/api/IImmutableProofVerifyRequest";
 export * from "./models/api/IImmutableProofVerifyResponse";
 export * from "./models/IImmutableProof";
+export * from "./models/IImmutableProofVerification";
 export * from "./models/IImmutableProofComponent";
 export * from "./models/immutableProofFailure";
 export * from "./models/immutableProofTypes";

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

@@ -1,7 +1,7 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IImmutableProof } from "./IImmutableProof";
-import type { ImmutableProofFailure } from "./immutableProofFailure";
+import type { IImmutableProofVerification } from "./IImmutableProofVerification";
 /**
  * Interface describing an immutable proof contract.
  */
@@ -28,10 +28,7 @@ export interface IImmutableProofComponent extends IComponent {
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    verify(id: string, proofObject: IJsonLdNodeObject): Promise<{
-        verified: boolean;
-        failure?: ImmutableProofFailure;
-    }>;
+    verify(id: string, proofObject: IJsonLdNodeObject): 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/IImmutableProofVerification.d.ts

@@ -0,0 +1,23 @@
+import type { ImmutableProofFailure } from "./immutableProofFailure";
+import type { ImmutableProofTypes } from "./immutableProofTypes";
+/**
+ * Interface describing an immutable proof verification.
+ */
+export interface IImmutableProofVerification {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof ImmutableProofTypes.ContextRoot;
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof ImmutableProofTypes.ImmutableProofVerification;
+    /**
+     * Was the verification successful.
+     */
+    verified: boolean;
+    /**
+     * If the verification was unsuccessful the failure reason.
+     */
+    failure?: ImmutableProofFailure;
+}

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

@@ -1,8 +1,15 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * Verify a proof.
  */
 export interface IImmutableProofVerifyRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
     /**
      * The parameters from the path.
      */

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

@@ -1,19 +1,17 @@
-import type { ImmutableProofFailure } from "../immutableProofFailure";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IImmutableProofVerification } from "../IImmutableProofVerification";
 /**
  * Response to verifying an immutable proof.
  */
 export interface IImmutableProofVerifyResponse {
     /**
-     * The response body.
+     * The headers which can be used to determine the response data type.
      */
-    body: {
-        /**
-         * Was the proof verified.
-         */
-        verified: boolean;
-        /**
-         * If not verified what was the failure.
-         */
-        failure?: ImmutableProofFailure;
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
+    /**
+     * The response body.
+     */
+    body: IImmutableProofVerification;
 }

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

@@ -10,6 +10,10 @@ export declare const ImmutableProofTypes: {
      * Represents Immutable Proof.
      */
     readonly ImmutableProof: "ImmutableProof";
+    /**
+     * Represents Immutable Proof Verification.
+     */
+    readonly ImmutableProofVerification: "ImmutableProofVerification";
 };
 /**
  * The types of immutable proof data.

package/docs/changelog.md

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

package/docs/reference/index.md

@@ -8,6 +8,7 @@
 
 - [IImmutableProof](interfaces/IImmutableProof.md)
 - [IImmutableProofComponent](interfaces/IImmutableProofComponent.md)
+- [IImmutableProofVerification](interfaces/IImmutableProofVerification.md)
 - [IImmutableProofCreateRequest](interfaces/IImmutableProofCreateRequest.md)
 - [IImmutableProofGetRequest](interfaces/IImmutableProofGetRequest.md)
 - [IImmutableProofGetResponse](interfaces/IImmutableProofGetResponse.md)

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -62,7 +62,7 @@ NotFoundError if the proof is not found.
 
 ### verify()
 
-> **verify**(`id`, `proofObject`): `Promise`\<`object`\>
+> **verify**(`id`, `proofObject`): `Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
 
 Verify an authentication proof.
 
@@ -78,18 +78,10 @@ The object to verify as JSON-LD.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
 
 The result of the verification and any failures.
 
-##### verified
-
-> **verified**: `boolean`
-
-##### failure?
-
-> `optional` **failure**: [`ImmutableProofFailure`](../type-aliases/ImmutableProofFailure.md)
-
 #### Throws
 
 NotFoundError if the proof is not found.

package/docs/reference/interfaces/IImmutableProofVerification.md

@@ -0,0 +1,35 @@
+# Interface: IImmutableProofVerification
+
+Interface describing an immutable proof verification.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/immutable-proof/"`
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"ImmutableProofVerification"`
+
+JSON-LD Type.
+
+***
+
+### verified
+
+> **verified**: `boolean`
+
+Was the verification successful.
+
+***
+
+### failure?
+
+> `optional` **failure**: [`ImmutableProofFailure`](../type-aliases/ImmutableProofFailure.md)
+
+If the verification was unsuccessful the failure reason.

package/docs/reference/interfaces/IImmutableProofVerifyRequest.md

@@ -4,6 +4,18 @@ Verify a proof.
 
 ## Properties
 
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
 ### pathParams
 
 > **pathParams**: `object`

package/docs/reference/interfaces/IImmutableProofVerifyResponse.md

@@ -4,20 +4,20 @@ Response to verifying an immutable proof.
 
 ## Properties
 
-### body
+### headers?
 
-> **body**: `object`
+> `optional` **headers**: `object`
 
-The response body.
+The headers which can be used to determine the response data type.
 
-#### verified
+#### content-type
 
-> **verified**: `boolean`
+> **content-type**: `"application/json"` \| `"application/ld+json"`
 
-Was the proof verified.
+***
 
-#### failure?
+### body
 
-> `optional` **failure**: [`ImmutableProofFailure`](../type-aliases/ImmutableProofFailure.md)
+> **body**: [`IImmutableProofVerification`](IImmutableProofVerification.md)
 
-If not verified what was the failure.
+The response body.

package/docs/reference/variables/ImmutableProofTypes.md

@@ -17,3 +17,9 @@ The context root for the immutable proof types.
 > `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`
 
 Represents Immutable Proof.
+
+### ImmutableProofVerification
+
+> `readonly` **ImmutableProofVerification**: `"ImmutableProofVerification"` = `"ImmutableProofVerification"`
+
+Represents Immutable Proof Verification.

package/package.json

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