@twin.org/immutable-proof-models 0.0.3-next.7 → 0.0.3-next.9

package/dist/es/index.js

@@ -9,6 +9,7 @@ export * from "./models/api/IImmutableProofVerifyResponse.js";
 export * from "./models/eventBus/IImmutableProofEventBusProofCreated.js";
 export * from "./models/IImmutableProof.js";
 export * from "./models/IImmutableProofComponent.js";
+export * from "./models/IImmutableProofReceipt.js";
 export * from "./models/IImmutableProofVerification.js";
 export * from "./models/immutableProofContexts.js";
 export * from "./models/immutableProofFailure.js";

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wCAAwC,CAAC;AACvD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AACzE,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sCAAsC,CAAC;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/immutableProofDataTypes.js\";\nexport * from \"./models/api/IImmutableProofCreateRequest.js\";\nexport * from \"./models/api/IImmutableProofGetRequest.js\";\nexport * from \"./models/api/IImmutableProofGetResponse.js\";\nexport * from \"./models/api/IImmutableProofVerifyRequest.js\";\nexport * from \"./models/api/IImmutableProofVerifyResponse.js\";\nexport * from \"./models/eventBus/IImmutableProofEventBusProofCreated.js\";\nexport * from \"./models/IImmutableProof.js\";\nexport * from \"./models/IImmutableProofComponent.js\";\nexport * from \"./models/IImmutableProofVerification.js\";\nexport * from \"./models/immutableProofContexts.js\";\nexport * from \"./models/immutableProofFailure.js\";\nexport * from \"./models/immutableProofTopics.js\";\nexport * from \"./models/immutableProofTypes.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wCAAwC,CAAC;AACvD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AACzE,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC;AACnD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/immutableProofDataTypes.js\";\nexport * from \"./models/api/IImmutableProofCreateRequest.js\";\nexport * from \"./models/api/IImmutableProofGetRequest.js\";\nexport * from \"./models/api/IImmutableProofGetResponse.js\";\nexport * from \"./models/api/IImmutableProofVerifyRequest.js\";\nexport * from \"./models/api/IImmutableProofVerifyResponse.js\";\nexport * from \"./models/eventBus/IImmutableProofEventBusProofCreated.js\";\nexport * from \"./models/IImmutableProof.js\";\nexport * from \"./models/IImmutableProofComponent.js\";\nexport * from \"./models/IImmutableProofReceipt.js\";\nexport * from \"./models/IImmutableProofVerification.js\";\nexport * from \"./models/immutableProofContexts.js\";\nexport * from \"./models/immutableProofFailure.js\";\nexport * from \"./models/immutableProofTopics.js\";\nexport * from \"./models/immutableProofTypes.js\";\n"]}

package/dist/es/models/IImmutableProof.js.map

@@ -1 +1 @@
-{"version":3,"file":"IImmutableProof.js","sourceRoot":"","sources":["../../../src/models/IImmutableProof.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IDataIntegrityProof } from \"@twin.org/standards-w3c-did\";\nimport type { ImmutableProofContexts } from \"./immutableProofContexts.js\";\nimport type { ImmutableProofTypes } from \"./immutableProofTypes.js\";\n\n/**\n * Interface describing an immutable proof state.\n */\nexport interface IImmutableProof {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof ImmutableProofContexts.Context,\n\t\ttypeof ImmutableProofContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof ImmutableProofTypes.ImmutableProof;\n\n\t/**\n\t * The id of the proof.\n\t */\n\tid: string;\n\n\t/**\n\t * The id of the object associated with the proof.\n\t * json-ld type:schema:identifier\n\t */\n\tproofObjectId?: string;\n\n\t/**\n\t * The hash of the object associated with the proof.\n\t * json-ld type:schema:Text\n\t */\n\tproofObjectHash: string;\n\n\t/**\n\t * The verifiable storage id for where the proof is stored.\n\t * json-ld type:schema:identifier\n\t */\n\tverifiableStorageId?: string;\n\n\t/**\n\t * The proof which can be undefined if it has not yet been issued.\n\t * json-ld id\n\t */\n\tproof?: IDataIntegrityProof;\n\n\t/**\n\t * The immutable receipt detail for where the proof is stored.\n\t * json-ld id\n\t */\n\timmutableReceipt?: IJsonLdNodeObject;\n}\n"]}
+{"version":3,"file":"IImmutableProof.js","sourceRoot":"","sources":["../../../src/models/IImmutableProof.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ImmutableProofContexts } from \"./immutableProofContexts.js\";\nimport type { ImmutableProofTypes } from \"./immutableProofTypes.js\";\n\n/**\n * Interface describing an immutable proof state.\n */\nexport interface IImmutableProof {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\"?: [typeof ImmutableProofContexts.Context, typeof ImmutableProofContexts.ContextCommon];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype?: typeof ImmutableProofTypes.ImmutableProof;\n\n\t/**\n\t * The id of the object associated with the proof.\n\t */\n\tid?: string;\n\n\t/**\n\t * The integrity hash of the object associated with the proof.\n\t * json-ld namespace:twin-common\n\t */\n\tproofIntegrity: string;\n}\n"]}

package/dist/es/models/IImmutableProofComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"IImmutableProofComponent.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IImmutableProof } from \"./IImmutableProof.js\";\nimport type { IImmutableProofVerification } from \"./IImmutableProofVerification.js\";\n\n/**\n * Interface describing an immutable proof contract.\n */\nexport interface IImmutableProofComponent extends IComponent {\n\t/**\n\t * Create a new proof.\n\t * @param document The document to create the proof for.\n\t * @returns The id of the new proof.\n\t */\n\tcreate(document: IJsonLdNodeObject): Promise<string>;\n\n\t/**\n\t * Get a proof.\n\t * @param id The id of the proof to get.\n\t * @returns The proof.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tget(id: string): Promise<IImmutableProof>;\n\n\t/**\n\t * Verify a proof.\n\t * @param id The id of the proof to verify.\n\t * @returns The result of the verification and any failures.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tverify(id: string): Promise<IImmutableProofVerification>;\n\n\t/**\n\t * Remove the verifiable storage for the proof.\n\t * @param id The id of the proof to remove the storage from.\n\t * @returns Nothing.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tremoveVerifiable(id: string): Promise<void>;\n}\n"]}
+{"version":3,"file":"IImmutableProofComponent.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IDidVerifiableCredential } from \"@twin.org/standards-w3c-did\";\nimport type { IImmutableProofVerification } from \"./IImmutableProofVerification.js\";\n\n/**\n * Interface describing an immutable proof contract.\n */\nexport interface IImmutableProofComponent extends IComponent {\n\t/**\n\t * Create a new proof.\n\t * @param document The document to create the proof for.\n\t * @returns The id of the new proof.\n\t */\n\tcreate(document: IJsonLdNodeObject): Promise<string>;\n\n\t/**\n\t * Get a proof.\n\t * @param id The id of the proof to get.\n\t * @returns The proof.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tget(id: string): Promise<IDidVerifiableCredential>;\n\n\t/**\n\t * Verify a proof.\n\t * @param id The id of the proof to verify.\n\t * @returns The result of the verification and any failures.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tverify(id: string): Promise<IImmutableProofVerification>;\n\n\t/**\n\t * Remove the verifiable storage for the proof.\n\t * @param id The id of the proof to remove the storage from.\n\t * @returns Nothing.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tremoveVerifiable(id: string): Promise<void>;\n}\n"]}

package/dist/es/models/IImmutableProofReceipt.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IImmutableProofReceipt.js.map

package/dist/es/models/IImmutableProofReceipt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofReceipt.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofReceipt.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { ImmutableProofContexts } from \"./immutableProofContexts.js\";\nimport type { ImmutableProofTypes } from \"./immutableProofTypes.js\";\n\n/**\n * Interface describing an immutable proof receipt.\n */\nexport interface IImmutableProofReceipt {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\"?: [typeof ImmutableProofContexts.Context, typeof ImmutableProofContexts.ContextCommon];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof ImmutableProofTypes.ImmutableProofReceipt;\n\n\t/**\n\t * The immutable receipt detail for where the proof is stored.\n\t * json-ld id\n\t */\n\timmutableReceipt?: IJsonLdNodeObject;\n\n\t/**\n\t * The verifiable storage id for where the proof is stored.\n\t * json-ld id\n\t */\n\tverifiableStorageId?: string;\n}\n"]}

package/dist/es/models/api/IImmutableProofGetResponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"IImmutableProofGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IImmutableProof } from \"../IImmutableProof.js\";\n\n/**\n * Response to getting an immutable proof.\n */\nexport interface IImmutableProofGetResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The response body.\n\t */\n\tbody: IImmutableProof;\n}\n"]}
+{"version":3,"file":"IImmutableProofGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDidVerifiableCredential } from \"@twin.org/standards-w3c-did\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Response to getting an immutable proof.\n */\nexport interface IImmutableProofGetResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The response body.\n\t */\n\tbody: IDidVerifiableCredential;\n}\n"]}

package/dist/es/models/immutableProofFailure.js

@@ -14,16 +14,12 @@ export const ImmutableProofFailure = {
      */
     ProofMissing: "proofMissing",
     /**
-     * Crypto suite mismatch.
+     * Verification failure.
      */
-    CryptoSuiteMismatch: "cryptoSuiteMismatch",
+    VerificationFailure: "verificationFailure",
     /**
-     * Proof type.
+     * Revoked.
      */
-    ProofTypeMismatch: "proofTypeMismatch",
-    /**
-     * Signature mismatch.
-     */
-    SignatureMismatch: "signatureMismatch"
+    Revoked: "revoked"
 };
 //# sourceMappingURL=immutableProofFailure.js.map

package/dist/es/models/immutableProofFailure.js.map

@@ -1 +1 @@
-{"version":3,"file":"immutableProofFailure.js","sourceRoot":"","sources":["../../../src/models/immutableProofFailure.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;IAEtC;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The failure reason of the proof.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofFailure = {\n\t/**\n\t * Proof not yet issued.\n\t */\n\tNotIssued: \"notIssued\",\n\n\t/**\n\t * Proof missing.\n\t */\n\tProofMissing: \"proofMissing\",\n\n\t/**\n\t * Crypto suite mismatch.\n\t */\n\tCryptoSuiteMismatch: \"cryptoSuiteMismatch\",\n\n\t/**\n\t * Proof type.\n\t */\n\tProofTypeMismatch: \"proofTypeMismatch\",\n\n\t/**\n\t * Signature mismatch.\n\t */\n\tSignatureMismatch: \"signatureMismatch\"\n} as const;\n\n/**\n * The failure reason of the proof.\n */\nexport type ImmutableProofFailure =\n\t(typeof ImmutableProofFailure)[keyof typeof ImmutableProofFailure];\n"]}
+{"version":3,"file":"immutableProofFailure.js","sourceRoot":"","sources":["../../../src/models/immutableProofFailure.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,OAAO,EAAE,SAAS;CACT,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The failure reason of the proof.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofFailure = {\n\t/**\n\t * Proof not yet issued.\n\t */\n\tNotIssued: \"notIssued\",\n\n\t/**\n\t * Proof missing.\n\t */\n\tProofMissing: \"proofMissing\",\n\n\t/**\n\t * Verification failure.\n\t */\n\tVerificationFailure: \"verificationFailure\",\n\n\t/**\n\t * Revoked.\n\t */\n\tRevoked: \"revoked\"\n} as const;\n\n/**\n * The failure reason of the proof.\n */\nexport type ImmutableProofFailure =\n\t(typeof ImmutableProofFailure)[keyof typeof ImmutableProofFailure];\n"]}

package/dist/es/models/immutableProofTypes.js

@@ -9,6 +9,10 @@ export const ImmutableProofTypes = {
      * Represents Immutable Proof.
      */
     ImmutableProof: "ImmutableProof",
+    /**
+     * Represents Immutable Proof Receipt.
+     */
+    ImmutableProofReceipt: "ImmutableProofReceipt",
     /**
      * Represents Immutable Proof Verification.
      */

package/dist/es/models/immutableProofTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"immutableProofTypes.js","sourceRoot":"","sources":["../../../src/models/immutableProofTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;OAEG;IACH,0BAA0B,EAAE,4BAA4B;CAC/C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of immutable proof data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofTypes = {\n\t/**\n\t * Represents Immutable Proof.\n\t */\n\tImmutableProof: \"ImmutableProof\",\n\n\t/**\n\t * Represents Immutable Proof Verification.\n\t */\n\tImmutableProofVerification: \"ImmutableProofVerification\"\n} as const;\n\n/**\n * The types of immutable proof data.\n */\nexport type ImmutableProofTypes = (typeof ImmutableProofTypes)[keyof typeof ImmutableProofTypes];\n"]}
+{"version":3,"file":"immutableProofTypes.js","sourceRoot":"","sources":["../../../src/models/immutableProofTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;OAEG;IACH,qBAAqB,EAAE,uBAAuB;IAE9C;;OAEG;IACH,0BAA0B,EAAE,4BAA4B;CAC/C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of immutable proof data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofTypes = {\n\t/**\n\t * Represents Immutable Proof.\n\t */\n\tImmutableProof: \"ImmutableProof\",\n\n\t/**\n\t * Represents Immutable Proof Receipt.\n\t */\n\tImmutableProofReceipt: \"ImmutableProofReceipt\",\n\n\t/**\n\t * Represents Immutable Proof Verification.\n\t */\n\tImmutableProofVerification: \"ImmutableProofVerification\"\n} as const;\n\n/**\n * The types of immutable proof data.\n */\nexport type ImmutableProofTypes = (typeof ImmutableProofTypes)[keyof typeof ImmutableProofTypes];\n"]}

package/dist/es/schemas/ImmutableProof.json

@@ -6,21 +6,19 @@
     "properties": {
         "@context": {
             "type": "array",
-            "minItems": 2,
-            "description": "JSON-LD Context.",
-            "prefixItems": [
-                {
-                    "type": "string",
-                    "const": "https://schema.twindev.org/immutable-proof/"
-                },
-                {
-                    "type": "string",
-                    "const": "https://schema.twindev.org/common/"
-                }
-            ],
             "items": {
-                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-            }
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "https://schema.twindev.org/immutable-proof/"
+                    },
+                    {
+                        "type": "string",
+                        "const": "https://schema.twindev.org/common/"
+                    }
+                ]
+            },
+            "description": "JSON-LD Context."
         },
         "type": {
             "type": "string",
@@ -29,34 +27,15 @@
         },
         "id": {
             "type": "string",
-            "description": "The id of the proof."
+            "description": "The id of the object associated with the proof."
         },
-        "proofObjectId": {
+        "proofIntegrity": {
             "type": "string",
-            "description": "The id of the object associated with the proof. json-ld type:schema:identifier"
-        },
-        "proofObjectHash": {
-            "type": "string",
-            "description": "The hash of the object associated with the proof. json-ld type:schema:Text"
-        },
-        "verifiableStorageId": {
-            "type": "string",
-            "description": "The verifiable storage id for where the proof is stored. json-ld type:schema:identifier"
-        },
-        "proof": {
-            "$ref": "https://schema.twindev.org/w3c-did/DataIntegrityProof",
-            "description": "The proof which can be undefined if it has not yet been issued. json-ld id"
-        },
-        "immutableReceipt": {
-            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-            "description": "The immutable receipt detail for where the proof is stored. json-ld id"
+            "description": "The integrity hash of the object associated with the proof. json-ld namespace:twin-common"
         }
     },
     "required": [
-        "@context",
-        "type",
-        "id",
-        "proofObjectHash"
+        "proofIntegrity"
     ],
     "additionalProperties": false
 }

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export * from "./models/api/IImmutableProofVerifyResponse.js";
 export * from "./models/eventBus/IImmutableProofEventBusProofCreated.js";
 export * from "./models/IImmutableProof.js";
 export * from "./models/IImmutableProofComponent.js";
+export * from "./models/IImmutableProofReceipt.js";
 export * from "./models/IImmutableProofVerification.js";
 export * from "./models/immutableProofContexts.js";
 export * from "./models/immutableProofFailure.js";

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

@@ -1,5 +1,3 @@
-import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IDataIntegrityProof } from "@twin.org/standards-w3c-did";
 import type { ImmutableProofContexts } from "./immutableProofContexts.js";
 import type { ImmutableProofTypes } from "./immutableProofTypes.js";
 /**
@@ -9,42 +7,18 @@ export interface IImmutableProof {
     /**
      * JSON-LD Context.
      */
-    "@context": [
-        typeof ImmutableProofContexts.Context,
-        typeof ImmutableProofContexts.ContextCommon,
-        ...IJsonLdContextDefinitionElement[]
-    ];
+    "@context"?: [typeof ImmutableProofContexts.Context, typeof ImmutableProofContexts.ContextCommon];
     /**
      * JSON-LD Type.
      */
-    type: typeof ImmutableProofTypes.ImmutableProof;
-    /**
-     * The id of the proof.
-     */
-    id: string;
+    type?: typeof ImmutableProofTypes.ImmutableProof;
     /**
      * The id of the object associated with the proof.
-     * json-ld type:schema:identifier
-     */
-    proofObjectId?: string;
-    /**
-     * The hash of the object associated with the proof.
-     * json-ld type:schema:Text
-     */
-    proofObjectHash: string;
-    /**
-     * The verifiable storage id for where the proof is stored.
-     * json-ld type:schema:identifier
-     */
-    verifiableStorageId?: string;
-    /**
-     * The proof which can be undefined if it has not yet been issued.
-     * json-ld id
      */
-    proof?: IDataIntegrityProof;
+    id?: string;
     /**
-     * The immutable receipt detail for where the proof is stored.
-     * json-ld id
+     * The integrity hash of the object associated with the proof.
+     * json-ld namespace:twin-common
      */
-    immutableReceipt?: IJsonLdNodeObject;
+    proofIntegrity: string;
 }

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IImmutableProof } from "./IImmutableProof.js";
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
 import type { IImmutableProofVerification } from "./IImmutableProofVerification.js";
 /**
  * Interface describing an immutable proof contract.
@@ -18,7 +18,7 @@ export interface IImmutableProofComponent extends IComponent {
      * @returns The proof.
      * @throws NotFoundError if the proof is not found.
      */
-    get(id: string): Promise<IImmutableProof>;
+    get(id: string): Promise<IDidVerifiableCredential>;
     /**
      * Verify a proof.
      * @param id The id of the proof to verify.

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

@@ -0,0 +1,26 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { ImmutableProofContexts } from "./immutableProofContexts.js";
+import type { ImmutableProofTypes } from "./immutableProofTypes.js";
+/**
+ * Interface describing an immutable proof receipt.
+ */
+export interface IImmutableProofReceipt {
+    /**
+     * JSON-LD Context.
+     */
+    "@context"?: [typeof ImmutableProofContexts.Context, typeof ImmutableProofContexts.ContextCommon];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof ImmutableProofTypes.ImmutableProofReceipt;
+    /**
+     * The immutable receipt detail for where the proof is stored.
+     * json-ld id
+     */
+    immutableReceipt?: IJsonLdNodeObject;
+    /**
+     * The verifiable storage id for where the proof is stored.
+     * json-ld id
+     */
+    verifiableStorageId?: string;
+}

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

@@ -1,5 +1,5 @@
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IImmutableProof } from "../IImmutableProof.js";
 /**
  * Response to getting an immutable proof.
  */
@@ -13,5 +13,5 @@ export interface IImmutableProofGetResponse {
     /**
      * The response body.
      */
-    body: IImmutableProof;
+    body: IDidVerifiableCredential;
 }

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

@@ -11,17 +11,13 @@ export declare const ImmutableProofFailure: {
      */
     readonly ProofMissing: "proofMissing";
     /**
-     * Crypto suite mismatch.
+     * Verification failure.
      */
-    readonly CryptoSuiteMismatch: "cryptoSuiteMismatch";
+    readonly VerificationFailure: "verificationFailure";
     /**
-     * Proof type.
+     * Revoked.
      */
-    readonly ProofTypeMismatch: "proofTypeMismatch";
-    /**
-     * Signature mismatch.
-     */
-    readonly SignatureMismatch: "signatureMismatch";
+    readonly Revoked: "revoked";
 };
 /**
  * The failure reason of the proof.

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

@@ -6,6 +6,10 @@ export declare const ImmutableProofTypes: {
      * Represents Immutable Proof.
      */
     readonly ImmutableProof: "ImmutableProof";
+    /**
+     * Represents Immutable Proof Receipt.
+     */
+    readonly ImmutableProofReceipt: "ImmutableProofReceipt";
     /**
      * Represents Immutable Proof Verification.
      */

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/immutable-proof-models - Changelog
 
+## [0.0.3-next.9](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.8...immutable-proof-models-v0.0.3-next.9) (2026-02-13)
+
+
+### Miscellaneous Chores
+
+* **immutable-proof-models:** Synchronize repo versions
+
+## [0.0.3-next.8](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.7...immutable-proof-models-v0.0.3-next.8) (2026-02-10)
+
+
+### Features
+
+* immutable proof as vc ([#31](https://github.com/twinfoundation/immutable-proof/issues/31)) ([79cdb03](https://github.com/twinfoundation/immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
+
 ## [0.0.3-next.7](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.6...immutable-proof-models-v0.0.3-next.7) (2026-02-05)
 
 

package/docs/reference/index.md

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

package/docs/reference/interfaces/IImmutableProof.md

@@ -4,69 +4,33 @@ Interface describing an immutable proof state.
 
 ## Properties
 
-### @context
+### @context?
 
-> **@context**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`\]
 
 JSON-LD Context.
 
 ***
 
-### type
+### type?
 
-> **type**: `"ImmutableProof"`
+> `optional` **type**: `"ImmutableProof"`
 
 JSON-LD Type.
 
 ***
 
-### id
+### id?
 
-> **id**: `string`
-
-The id of the proof.
-
-***
-
-### proofObjectId?
-
-> `optional` **proofObjectId**: `string`
+> `optional` **id**: `string`
 
 The id of the object associated with the proof.
-json-ld type:schema:identifier
-
-***
-
-### proofObjectHash
-
-> **proofObjectHash**: `string`
-
-The hash of the object associated with the proof.
-json-ld type:schema:Text
-
-***
-
-### verifiableStorageId?
-
-> `optional` **verifiableStorageId**: `string`
-
-The verifiable storage id for where the proof is stored.
-json-ld type:schema:identifier
-
-***
-
-### proof?
-
-> `optional` **proof**: `IDataIntegrityProof`
-
-The proof which can be undefined if it has not yet been issued.
-json-ld id
 
 ***
 
-### immutableReceipt?
+### proofIntegrity
 
-> `optional` **immutableReceipt**: `IJsonLdNodeObject`
+> **proofIntegrity**: `string`
 
-The immutable receipt detail for where the proof is stored.
-json-ld id
+The integrity hash of the object associated with the proof.
+json-ld namespace:twin-common

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -32,7 +32,7 @@ The id of the new proof.
 
 ### get()
 
-> **get**(`id`): `Promise`\<[`IImmutableProof`](IImmutableProof.md)\>
+> **get**(`id`): `Promise`\<`IDidVerifiableCredential`\>
 
 Get a proof.
 
@@ -46,7 +46,7 @@ The id of the proof to get.
 
 #### Returns
 
-`Promise`\<[`IImmutableProof`](IImmutableProof.md)\>
+`Promise`\<`IDidVerifiableCredential`\>
 
 The proof.
 

package/docs/reference/interfaces/IImmutableProofGetResponse.md

@@ -18,6 +18,6 @@ The headers which can be used to determine the response data type.
 
 ### body
 
-> **body**: [`IImmutableProof`](IImmutableProof.md)
+> **body**: `IDidVerifiableCredential`
 
 The response body.

package/docs/reference/interfaces/IImmutableProofReceipt.md

@@ -0,0 +1,37 @@
+# Interface: IImmutableProofReceipt
+
+Interface describing an immutable proof receipt.
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"ImmutableProofReceipt"`
+
+JSON-LD Type.
+
+***
+
+### immutableReceipt?
+
+> `optional` **immutableReceipt**: `IJsonLdNodeObject`
+
+The immutable receipt detail for where the proof is stored.
+json-ld id
+
+***
+
+### verifiableStorageId?
+
+> `optional` **verifiableStorageId**: `string`
+
+The verifiable storage id for where the proof is stored.
+json-ld id

package/docs/reference/variables/ImmutableProofFailure.md

@@ -18,20 +18,14 @@ Proof not yet issued.
 
 Proof missing.
 
-### CryptoSuiteMismatch
+### VerificationFailure
 
-> `readonly` **CryptoSuiteMismatch**: `"cryptoSuiteMismatch"` = `"cryptoSuiteMismatch"`
+> `readonly` **VerificationFailure**: `"verificationFailure"` = `"verificationFailure"`
 
-Crypto suite mismatch.
+Verification failure.
 
-### ProofTypeMismatch
+### Revoked
 
-> `readonly` **ProofTypeMismatch**: `"proofTypeMismatch"` = `"proofTypeMismatch"`
+> `readonly` **Revoked**: `"revoked"` = `"revoked"`
 
-Proof type.
-
-### SignatureMismatch
-
-> `readonly` **SignatureMismatch**: `"signatureMismatch"` = `"signatureMismatch"`
-
-Signature mismatch.
+Revoked.

package/docs/reference/variables/ImmutableProofTypes.md

@@ -12,6 +12,12 @@ The types of immutable proof data.
 
 Represents Immutable Proof.
 
+### ImmutableProofReceipt
+
+> `readonly` **ImmutableProofReceipt**: `"ImmutableProofReceipt"` = `"ImmutableProofReceipt"`
+
+Represents Immutable Proof Receipt.
+
 ### ImmutableProofVerification
 
 > `readonly` **ImmutableProofVerification**: `"ImmutableProofVerification"` = `"ImmutableProofVerification"`

package/package.json

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