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

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Immutable Proof Models
 
-Models which define the structure of the immutable proof connectors and services.
+This package defines the shared contracts used by immutable proof components, including request and response models, verification structures, topics, and schema context values. It provides a stable foundation so services, tasks, and clients can exchange data consistently.
 
 ## Installation
 

package/dist/es/dataTypes/immutableProofDataTypes.js

@@ -1,9 +1,12 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-import { DataTypeHandlerFactory } from "@twin.org/data-core";
+import { DataTypeHelper } from "@twin.org/data-core";
 import { ImmutableProofContexts } from "../models/immutableProofContexts.js";
 import { ImmutableProofTypes } from "../models/immutableProofTypes.js";
 import ImmutableProofSchema from "../schemas/ImmutableProof.json" with { type: "json" };
+import ImmutableProofFailureSchema from "../schemas/ImmutableProofFailure.json" with { type: "json" };
+import ImmutableProofReceiptSchema from "../schemas/ImmutableProofReceipt.json" with { type: "json" };
+import ImmutableProofVerificationSchema from "../schemas/ImmutableProofVerification.json" with { type: "json" };
 /**
  * Handle all the data types for immutable proof.
  */
@@ -12,12 +15,25 @@ export class ImmutableProofDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        DataTypeHandlerFactory.register(`${ImmutableProofContexts.Namespace}${ImmutableProofTypes.ImmutableProof}`, () => ({
-            namespace: ImmutableProofContexts.Namespace,
-            type: ImmutableProofTypes.ImmutableProof,
-            defaultValue: {},
-            jsonSchema: async () => ImmutableProofSchema
-        }));
+        const types = [
+            {
+                type: ImmutableProofTypes.ImmutableProof,
+                schema: ImmutableProofSchema
+            },
+            {
+                type: ImmutableProofTypes.ImmutableProofReceipt,
+                schema: ImmutableProofReceiptSchema
+            },
+            {
+                type: ImmutableProofTypes.ImmutableProofVerification,
+                schema: ImmutableProofVerificationSchema
+            },
+            {
+                type: ImmutableProofTypes.ImmutableProofFailure,
+                schema: ImmutableProofFailureSchema
+            }
+        ];
+        DataTypeHelper.registerTypes(ImmutableProofContexts.Namespace, ImmutableProofContexts.JsonLdContext, types.map(t => ({ type: t.type, schema: t.schema })));
     }
 }
 //# sourceMappingURL=immutableProofDataTypes.js.map

package/dist/es/dataTypes/immutableProofDataTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"immutableProofDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/immutableProofDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,sBAAsB,EAAoB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,oBAAoB,MAAM,gCAAgC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAExF;;GAEG;AACH,MAAM,OAAO,uBAAuB;IACnC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,sBAAsB,CAAC,SAAS,GAAG,mBAAmB,CAAC,cAAc,EAAE,EAC1E,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,sBAAsB,CAAC,SAAS;YAC3C,IAAI,EAAE,mBAAmB,CAAC,cAAc;YACxC,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,oBAAmC;SAC3D,CAAC,CACF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHandlerFactory, type IJsonSchema } from \"@twin.org/data-core\";\nimport { ImmutableProofContexts } from \"../models/immutableProofContexts.js\";\nimport { ImmutableProofTypes } from \"../models/immutableProofTypes.js\";\nimport ImmutableProofSchema from \"../schemas/ImmutableProof.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for immutable proof.\n */\nexport class ImmutableProofDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${ImmutableProofContexts.Namespace}${ImmutableProofTypes.ImmutableProof}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: ImmutableProofContexts.Namespace,\n\t\t\t\ttype: ImmutableProofTypes.ImmutableProof,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => ImmutableProofSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\t}\n}\n"]}
+{"version":3,"file":"immutableProofDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/immutableProofDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,oBAAoB,MAAM,gCAAgC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACxF,OAAO,2BAA2B,MAAM,uCAAuC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACtG,OAAO,2BAA2B,MAAM,uCAAuC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACtG,OAAO,gCAAgC,MAAM,4CAA4C,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAEhH;;GAEG;AACH,MAAM,OAAO,uBAAuB;IACnC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,MAAM,KAAK,GAAG;YACb;gBACC,IAAI,EAAE,mBAAmB,CAAC,cAAc;gBACxC,MAAM,EAAE,oBAAoB;aAC5B;YACD;gBACC,IAAI,EAAE,mBAAmB,CAAC,qBAAqB;gBAC/C,MAAM,EAAE,2BAA2B;aACnC;YACD;gBACC,IAAI,EAAE,mBAAmB,CAAC,0BAA0B;gBACpD,MAAM,EAAE,gCAAgC;aACxC;YACD;gBACC,IAAI,EAAE,mBAAmB,CAAC,qBAAqB;gBAC/C,MAAM,EAAE,2BAA2B;aACnC;SACD,CAAC;QAEF,cAAc,CAAC,aAAa,CAC3B,sBAAsB,CAAC,SAAS,EAChC,sBAAsB,CAAC,aAAa,EACpC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CACpD,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHelper } from \"@twin.org/data-core\";\nimport { ImmutableProofContexts } from \"../models/immutableProofContexts.js\";\nimport { ImmutableProofTypes } from \"../models/immutableProofTypes.js\";\nimport ImmutableProofSchema from \"../schemas/ImmutableProof.json\" with { type: \"json\" };\nimport ImmutableProofFailureSchema from \"../schemas/ImmutableProofFailure.json\" with { type: \"json\" };\nimport ImmutableProofReceiptSchema from \"../schemas/ImmutableProofReceipt.json\" with { type: \"json\" };\nimport ImmutableProofVerificationSchema from \"../schemas/ImmutableProofVerification.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for immutable proof.\n */\nexport class ImmutableProofDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tconst types = [\n\t\t\t{\n\t\t\t\ttype: ImmutableProofTypes.ImmutableProof,\n\t\t\t\tschema: ImmutableProofSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: ImmutableProofTypes.ImmutableProofReceipt,\n\t\t\t\tschema: ImmutableProofReceiptSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: ImmutableProofTypes.ImmutableProofVerification,\n\t\t\t\tschema: ImmutableProofVerificationSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: ImmutableProofTypes.ImmutableProofFailure,\n\t\t\t\tschema: ImmutableProofFailureSchema\n\t\t\t}\n\t\t];\n\n\t\tDataTypeHelper.registerTypes(\n\t\t\tImmutableProofContexts.Namespace,\n\t\t\tImmutableProofContexts.JsonLdContext,\n\t\t\ttypes.map(t => ({ type: t.type, schema: t.schema }))\n\t\t);\n\t}\n}\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 { 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"]}
+{"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/IImmutableProofReceipt.js.map

@@ -1 +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"]}
+{"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/IImmutableProofVerification.js.map

@@ -1 +1 @@
-{"version":3,"file":"IImmutableProofVerification.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofVerification.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ImmutableProofContexts } from \"./immutableProofContexts.js\";\nimport type { ImmutableProofFailure } from \"./immutableProofFailure.js\";\nimport type { ImmutableProofTypes } from \"./immutableProofTypes.js\";\n\n/**\n * Interface describing an immutable proof verification.\n */\nexport interface IImmutableProofVerification {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": typeof ImmutableProofContexts.Context;\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof ImmutableProofTypes.ImmutableProofVerification;\n\n\t/**\n\t * Was the verification successful.\n\t * json-ld namespace:twin-common\n\t */\n\tverified: boolean;\n\n\t/**\n\t * If the verification was unsuccessful the failure reason.\n\t * json-ld type:schema:Text\n\t */\n\tfailure?: ImmutableProofFailure;\n}\n"]}
+{"version":3,"file":"IImmutableProofVerification.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofVerification.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ImmutableProofContexts } from \"./immutableProofContexts.js\";\nimport type { ImmutableProofFailure } from \"./immutableProofFailure.js\";\nimport type { ImmutableProofTypes } from \"./immutableProofTypes.js\";\n\n/**\n * Interface describing an immutable proof verification.\n */\nexport interface IImmutableProofVerification {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": typeof ImmutableProofContexts.Context;\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof ImmutableProofTypes.ImmutableProofVerification;\n\n\t/**\n\t * Was the verification successful.\n\t * @json-ld namespace:twin-common\n\t */\n\tverified: boolean;\n\n\t/**\n\t * If the verification was unsuccessful the failure reason.\n\t * @json-ld type:schema:Text\n\t */\n\tfailure?: ImmutableProofFailure;\n}\n"]}

package/dist/es/models/immutableProofTypes.js

@@ -16,6 +16,10 @@ export const ImmutableProofTypes = {
     /**
      * Represents Immutable Proof Verification.
      */
-    ImmutableProofVerification: "ImmutableProofVerification"
+    ImmutableProofVerification: "ImmutableProofVerification",
+    /**
+     * Represents Immutable Proof Failure.
+     */
+    ImmutableProofFailure: "ImmutableProofFailure"
 };
 //# sourceMappingURL=immutableProofTypes.js.map

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,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"]}
+{"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;IAExD;;OAEG;IACH,qBAAqB,EAAE,uBAAuB;CACrC,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\n\t/**\n\t * Represents Immutable Proof Failure.\n\t */\n\tImmutableProofFailure: \"ImmutableProofFailure\"\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

@@ -1,27 +1,26 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/immutable-proof/ImmutableProof",
+    "title": "ImmutableProof",
     "description": "Interface describing an immutable proof state.",
     "type": "object",
     "properties": {
         "@context": {
             "type": "array",
-            "items": {
-                "allOf": [
-                    {
-                        "type": "string",
-                        "const": "https://schema.twindev.org/immutable-proof/"
-                    },
-                    {
-                        "type": "string",
-                        "const": "https://schema.twindev.org/common/"
-                    }
-                ]
-            },
+            "prefixItems": [
+                {
+                    "const": "https://schema.twindev.org/immutable-proof/"
+                },
+                {
+                    "const": "https://schema.twindev.org/common/"
+                }
+            ],
+            "items": false,
+            "minItems": 2,
+            "maxItems": 2,
             "description": "JSON-LD Context."
         },
         "type": {
-            "type": "string",
             "const": "ImmutableProof",
             "description": "JSON-LD Type."
         },
@@ -31,7 +30,7 @@
         },
         "proofIntegrity": {
             "type": "string",
-            "description": "The integrity hash of the object associated with the proof. json-ld namespace:twin-common"
+            "description": "The integrity hash of the object associated with the proof."
         }
     },
     "required": [

package/dist/es/schemas/ImmutableProofFailure.json

@@ -0,0 +1,24 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/immutable-proof/ImmutableProofFailure",
+    "title": "ImmutableProofFailure",
+    "description": "The failure reason of the proof.",
+    "oneOf": [
+        {
+            "const": "notIssued",
+            "description": "Proof not yet issued."
+        },
+        {
+            "const": "proofMissing",
+            "description": "Proof missing."
+        },
+        {
+            "const": "verificationFailure",
+            "description": "Verification failure."
+        },
+        {
+            "const": "revoked",
+            "description": "Revoked."
+        }
+    ]
+}

package/dist/es/schemas/ImmutableProofReceipt.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/immutable-proof/ImmutableProofReceipt",
+    "title": "ImmutableProofReceipt",
+    "description": "Interface describing an immutable proof receipt.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "prefixItems": [
+                {
+                    "const": "https://schema.twindev.org/immutable-proof/"
+                },
+                {
+                    "const": "https://schema.twindev.org/common/"
+                }
+            ],
+            "items": false,
+            "minItems": 2,
+            "maxItems": 2,
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "const": "ImmutableProofReceipt",
+            "description": "JSON-LD Type."
+        },
+        "immutableReceipt": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+            "description": "The immutable receipt detail for where the proof is stored."
+        },
+        "verifiableStorageId": {
+            "type": "string",
+            "description": "The verifiable storage id for where the proof is stored."
+        }
+    },
+    "required": [
+        "type"
+    ]
+}

package/dist/es/schemas/ImmutableProofVerification.json

@@ -0,0 +1,30 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/immutable-proof/ImmutableProofVerification",
+    "title": "ImmutableProofVerification",
+    "description": "Interface describing an immutable proof verification.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "const": "https://schema.twindev.org/immutable-proof/",
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "const": "ImmutableProofVerification",
+            "description": "JSON-LD Type."
+        },
+        "verified": {
+            "type": "boolean",
+            "description": "Was the verification successful."
+        },
+        "failure": {
+            "$ref": "https://schema.twindev.org/immutable-proof/ImmutableProofFailure",
+            "description": "If the verification was unsuccessful the failure reason."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "verified"
+    ]
+}

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

@@ -18,7 +18,7 @@ export interface IImmutableProof {
     id?: string;
     /**
      * The integrity hash of the object associated with the proof.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     proofIntegrity: string;
 }

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

@@ -15,12 +15,12 @@ export interface IImmutableProofReceipt {
     type: typeof ImmutableProofTypes.ImmutableProofReceipt;
     /**
      * The immutable receipt detail for where the proof is stored.
-     * json-ld id
+     * @json-ld id
      */
     immutableReceipt?: IJsonLdNodeObject;
     /**
      * The verifiable storage id for where the proof is stored.
-     * json-ld id
+     * @json-ld id
      */
     verifiableStorageId?: string;
 }

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

@@ -15,12 +15,12 @@ export interface IImmutableProofVerification {
     type: typeof ImmutableProofTypes.ImmutableProofVerification;
     /**
      * Was the verification successful.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     verified: boolean;
     /**
      * If the verification was unsuccessful the failure reason.
-     * json-ld type:schema:Text
+     * @json-ld type:schema:Text
      */
     failure?: ImmutableProofFailure;
 }

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

@@ -14,6 +14,10 @@ export declare const ImmutableProofTypes: {
      * 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,11 @@
-# @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)
 

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/interfaces/IImmutableProof.md

@@ -4,33 +4,32 @@ Interface describing an immutable proof state.
 
 ## Properties
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`\]
+> `optional` **@context?**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`\]
 
 JSON-LD Context.
 
 ***
 
-### type?
+### type? {#type}
 
-> `optional` **type**: `"ImmutableProof"`
+> `optional` **type?**: `"ImmutableProof"`
 
 JSON-LD Type.
 
 ***
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the object associated with the proof.
 
 ***
 
-### proofIntegrity
+### proofIntegrity {#proofintegrity}
 
 > **proofIntegrity**: `string`
 
 The integrity hash of the object associated with the proof.
-json-ld namespace:twin-common

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,7 +30,7 @@ The id of the new proof.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`): `Promise`\<`IDidVerifiableCredential`\>
 
@@ -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,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IDidVerifiableCredential`
 

package/docs/reference/interfaces/IImmutableProofReceipt.md

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

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,18 +20,16 @@ JSON-LD Type.
 
 ***
 
-### verified
+### verified {#verified}
 
 > **verified**: `boolean`
 
 Was the verification successful.
-json-ld namespace:twin-common
 
 ***
 
-### 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.
-json-ld type:schema:Text

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,37 +6,37 @@ The contexts of immutable proof data.
 
 ## Type Declaration
 
-### Namespace
+### Namespace {#namespace}
 
 > `readonly` **Namespace**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
 
 The canonical RDF namespace URI for Immutable Proof.
 
-### Context
+### Context {#context}
 
 > `readonly` **Context**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
 
 The value to use in context for Immutable Proof.
 
-### JsonLdContext
+### 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 {#namespacecommon}
 
 > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The canonical RDF namespace URI for TWIN Common.
 
-### ContextCommon
+### 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 {#jsonldcontextcommon}
 
 > `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
 

package/docs/reference/variables/ImmutableProofFailure.md

@@ -6,25 +6,25 @@ 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.
 
-### VerificationFailure
+### VerificationFailure {#verificationfailure}
 
 > `readonly` **VerificationFailure**: `"verificationFailure"` = `"verificationFailure"`
 
 Verification failure.
 
-### Revoked
+### Revoked {#revoked}
 
 > `readonly` **Revoked**: `"revoked"` = `"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,20 +6,26 @@ The types of immutable proof data.
 
 ## Type Declaration
 
-### ImmutableProof
+### ImmutableProof {#immutableproof}
 
 > `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`
 
 Represents Immutable Proof.
 
-### ImmutableProofReceipt
+### ImmutableProofReceipt {#immutableproofreceipt}
 
 > `readonly` **ImmutableProofReceipt**: `"ImmutableProofReceipt"` = `"ImmutableProofReceipt"`
 
 Represents Immutable Proof Receipt.
 
-### ImmutableProofVerification
+### 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.10",
-	"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",