@twin.org/immutable-proof-models 0.0.3-next.1 → 0.0.3-next.11

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

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

package/docs/changelog.md

@@ -1,4 +1,74 @@
-# @twin.org/immutable-proof-models - Changelog
+# Changelog
+
+## [0.0.3-next.11](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.10...immutable-proof-models-v0.0.3-next.11) (2026-03-25)
+
+
+### Features
+
+* add missing proof type registration ([1e9f52b](https://github.com/twinfoundation/immutable-proof/commit/1e9f52b88ab201e97c9d2aa7611fb8f77a82d614))
+
+## [0.0.3-next.10](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.9...immutable-proof-models-v0.0.3-next.10) (2026-02-25)
+
+
+### Features
+
+* update schemas ([ab0569a](https://github.com/twinfoundation/immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
+
+## [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)
+
+
+### Features
+
+* add ts-to-jsonld-context tool ([871191b](https://github.com/twinfoundation/immutable-proof/commit/871191b75cb82c2f6daaab08a71384ba92f02a64))
+
+## [0.0.3-next.6](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.5...immutable-proof-models-v0.0.3-next.6) (2026-01-21)
+
+
+### Features
+
+* update contexts ([#22](https://github.com/twinfoundation/immutable-proof/issues/22)) ([645b880](https://github.com/twinfoundation/immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
+
+## [0.0.3-next.5](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.4...immutable-proof-models-v0.0.3-next.5) (2026-01-14)
+
+
+### Features
+
+* update contexts and namespaces ([#20](https://github.com/twinfoundation/immutable-proof/issues/20)) ([d38aa69](https://github.com/twinfoundation/immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
+
+## [0.0.3-next.4](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.3...immutable-proof-models-v0.0.3-next.4) (2026-01-07)
+
+
+### Miscellaneous Chores
+
+* **immutable-proof-models:** Synchronize repo versions
+
+## [0.0.3-next.3](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.2...immutable-proof-models-v0.0.3-next.3) (2025-11-28)
+
+
+### Miscellaneous Chores
+
+* **immutable-proof-models:** Synchronize repo versions
+
+## [0.0.3-next.2](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.1...immutable-proof-models-v0.0.3-next.2) (2025-11-28)
+
+
+### Miscellaneous Chores
+
+* **immutable-proof-models:** Synchronize repo versions
 
 ## [0.0.3-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.0...immutable-proof-models-v0.0.3-next.1) (2025-11-12)
 

package/docs/examples.md

@@ -1 +1,72 @@
-# @twin.org/immutable-proof-models - Examples
+# Immutable Proof Models Examples
+
+These snippets show how to register data types and then use the immutable proof model contracts in request and response flows.
+
+## ImmutableProofDataTypes
+
+```typescript
+import { DataTypeHandlerFactory } from '@twin.org/data-core';
+import { ImmutableProofDataTypes, ImmutableProofTypes } from '@twin.org/immutable-proof-models';
+
+ImmutableProofDataTypes.registerTypes();
+
+const handler = DataTypeHandlerFactory.get(
+  'https://schema.twindev.org/immutable-proof/ImmutableProof'
+);
+console.log(handler.type === ImmutableProofTypes.ImmutableProof); // true
+```
+
+## Model Contracts
+
+```typescript
+import type {
+  IImmutableProofCreateRequest,
+  IImmutableProofGetResponse,
+  IImmutableProofVerifyResponse
+} from '@twin.org/immutable-proof-models';
+
+const createRequest: IImmutableProofCreateRequest = {
+  body: {
+    document: {
+      '@context': 'https://schema.org',
+      type: 'Person',
+      name: 'Alice Example'
+    }
+  }
+};
+
+console.log(createRequest.body.document.type); // Person
+```
+
+```typescript
+import { ImmutableProofFailure, ImmutableProofTypes } from '@twin.org/immutable-proof-models';
+import type {
+  IImmutableProofGetResponse,
+  IImmutableProofVerifyResponse
+} from '@twin.org/immutable-proof-models';
+
+const getResponse: IImmutableProofGetResponse = {
+  body: {
+    '@context': ['https://www.w3.org/2018/credentials/v1'],
+    type: ['VerifiableCredential', ImmutableProofTypes.ImmutableProof],
+    issuer: 'did:iota:tst:issuer',
+    id: 'immutable-proof:01JABCDEF1234567890',
+    credentialSubject: {
+      id: 'https://example.org/documents/100',
+      proofIntegrity: 'yEr9VvYCGDh2Ww1YwQMehUy4LlW35mLhX8j8R8U6x0g='
+    }
+  }
+};
+
+const verifyResponse: IImmutableProofVerifyResponse = {
+  body: {
+    '@context': 'https://schema.twindev.org/immutable-proof',
+    type: ImmutableProofTypes.ImmutableProofVerification,
+    verified: false,
+    failure: ImmutableProofFailure.ProofMissing
+  }
+};
+
+console.log(getResponse.body.id); // immutable-proof:01JABCDEF1234567890
+console.log(verifyResponse.body.failure); // proof-missing
+```

package/docs/reference/classes/ImmutableProofDataTypes.md

@@ -14,7 +14,7 @@ Handle all the data types for immutable proof.
 
 ## Methods
 
-### registerTypes()
+### registerTypes() {#registertypes}
 
 > `static` **registerTypes**(): `void`
 

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,64 +4,32 @@ Interface describing an immutable proof state.
 
 ## Properties
 
-### @context
+### @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}
 
-> **type**: `"ImmutableProof"`
+> `optional` **type?**: `"ImmutableProof"`
 
 JSON-LD Type.
 
 ***
 
-### id
+### 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.
 
 ***
 
-### proofObjectHash
-
-> **proofObjectHash**: `string`
-
-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**: `IDataIntegrityProof`
-
-The proof which can be undefined if it has not yet been issued.
-
-***
-
-### immutableReceipt?
+### proofIntegrity {#proofintegrity}
 
-> `optional` **immutableReceipt**: `IJsonLdNodeObject`
+> **proofIntegrity**: `string`
 
-The immutable receipt detail for where the proof is stored.
+The integrity hash of the object associated with the proof.

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -8,7 +8,7 @@ Interface describing an immutable proof contract.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`document`): `Promise`\<`string`\>
 
@@ -30,9 +30,9 @@ The id of the new proof.
 
 ***
 
-### get()
+### get() {#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.
 
@@ -56,7 +56,7 @@ NotFoundError if the proof is not found.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > **verify**(`id`): `Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
 
@@ -82,7 +82,7 @@ NotFoundError if the proof is not found.
 
 ***
 
-### removeVerifiable()
+### removeVerifiable() {#removeverifiable}
 
 > **removeVerifiable**(`id`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IImmutableProofCreateRequest.md

@@ -4,7 +4,7 @@ Create a proof.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/IImmutableProofEventBusProofCreated.md

@@ -4,7 +4,7 @@ Event bus payload for proof created.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 

package/docs/reference/interfaces/IImmutableProofGetRequest.md

@@ -4,9 +4,9 @@ Get a proof.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IImmutableProofGetResponse.md

@@ -4,9 +4,9 @@ Response to getting an immutable proof.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,8 +16,8 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
-> **body**: [`IImmutableProof`](IImmutableProof.md)
+> **body**: `IDidVerifiableCredential`
 
 The response body.

package/docs/reference/interfaces/IImmutableProofReceipt.md

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

package/docs/reference/interfaces/IImmutableProofVerification.md

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

package/docs/reference/interfaces/IImmutableProofVerifyRequest.md

@@ -4,9 +4,9 @@ Verify a proof.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IImmutableProofVerifyResponse.md

@@ -4,9 +4,9 @@ Response to verifying an immutable proof.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IImmutableProofVerification`](IImmutableProofVerification.md)
 

package/docs/reference/variables/ImmutableProofContexts.md

@@ -6,14 +6,38 @@ The contexts of immutable proof data.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace {#namespace}
 
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
+> `readonly` **Namespace**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
 
-The context root for the immutable proof types.
+The canonical RDF namespace URI for Immutable Proof.
 
-### ContextRootCommon
+### Context {#context}
 
-> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+> `readonly` **Context**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
 
-The context root for the common types.
+The value to use in context for Immutable Proof.
+
+### JsonLdContext {#jsonldcontext}
+
+> `readonly` **JsonLdContext**: `"https://schema.twindev.org/immutable-proof/types.jsonld"` = `"https://schema.twindev.org/immutable-proof/types.jsonld"`
+
+The JSON-LD Context URL for Immutable Proof.
+
+### NamespaceCommon {#namespacecommon}
+
+> `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The canonical RDF namespace URI for TWIN Common.
+
+### ContextCommon {#contextcommon}
+
+> `readonly` **ContextCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The value to use in JSON-LD context for TWIN Common.
+
+### JsonLdContextCommon {#jsonldcontextcommon}
+
+> `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
+
+The JSON-LD Context URL for TWIN Common.

package/docs/reference/variables/ImmutableProofFailure.md

@@ -6,32 +6,26 @@ The failure reason of the proof.
 
 ## Type Declaration
 
-### NotIssued
+### NotIssued {#notissued}
 
 > `readonly` **NotIssued**: `"notIssued"` = `"notIssued"`
 
 Proof not yet issued.
 
-### ProofMissing
+### ProofMissing {#proofmissing}
 
 > `readonly` **ProofMissing**: `"proofMissing"` = `"proofMissing"`
 
 Proof missing.
 
-### CryptoSuiteMismatch
+### VerificationFailure {#verificationfailure}
 
-> `readonly` **CryptoSuiteMismatch**: `"cryptoSuiteMismatch"` = `"cryptoSuiteMismatch"`
+> `readonly` **VerificationFailure**: `"verificationFailure"` = `"verificationFailure"`
 
-Crypto suite mismatch.
+Verification failure.
 
-### ProofTypeMismatch
+### Revoked {#revoked}
 
-> `readonly` **ProofTypeMismatch**: `"proofTypeMismatch"` = `"proofTypeMismatch"`
+> `readonly` **Revoked**: `"revoked"` = `"revoked"`
 
-Proof type.
-
-### SignatureMismatch
-
-> `readonly` **SignatureMismatch**: `"signatureMismatch"` = `"signatureMismatch"`
-
-Signature mismatch.
+Revoked.

package/docs/reference/variables/ImmutableProofTopics.md

@@ -6,7 +6,7 @@ The topics for immutable proof event bus notifications.
 
 ## Type Declaration
 
-### ProofCreated
+### ProofCreated {#proofcreated}
 
 > `readonly` **ProofCreated**: `"immutable-proof:proof-created"` = `"immutable-proof:proof-created"`
 

package/docs/reference/variables/ImmutableProofTypes.md

@@ -6,14 +6,26 @@ The types of immutable proof data.
 
 ## Type Declaration
 
-### ImmutableProof
+### ImmutableProof {#immutableproof}
 
 > `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`
 
 Represents Immutable Proof.
 
-### ImmutableProofVerification
+### ImmutableProofReceipt {#immutableproofreceipt}
+
+> `readonly` **ImmutableProofReceipt**: `"ImmutableProofReceipt"` = `"ImmutableProofReceipt"`
+
+Represents Immutable Proof Receipt.
+
+### ImmutableProofVerification {#immutableproofverification}
 
 > `readonly` **ImmutableProofVerification**: `"ImmutableProofVerification"` = `"ImmutableProofVerification"`
 
 Represents Immutable Proof Verification.
+
+### ImmutableProofFailure {#immutableprooffailure}
+
+> `readonly` **ImmutableProofFailure**: `"ImmutableProofFailure"` = `"ImmutableProofFailure"`
+
+Represents Immutable Proof Failure.

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/immutable-proof-models",
-	"version": "0.0.3-next.1",
-	"description": "Models which define the structure of the immutable proof connectors and services",
+	"version": "0.0.3-next.11",
+	"description": "Shared model contracts, schema types, and context constants for immutable proof workflows",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/immutable-proof.git",