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

package/dist/es/dataTypes/immutableProofDataTypes.js

@@ -0,0 +1,23 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { DataTypeHandlerFactory } 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" };
+/**
+ * Handle all the data types for immutable proof.
+ */
+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
+        }));
+    }
+}
+//# sourceMappingURL=immutableProofDataTypes.js.map

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

@@ -0,0 +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"]}

package/dist/es/index.js

@@ -0,0 +1,18 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./dataTypes/immutableProofDataTypes.js";
+export * from "./models/api/IImmutableProofCreateRequest.js";
+export * from "./models/api/IImmutableProofGetRequest.js";
+export * from "./models/api/IImmutableProofGetResponse.js";
+export * from "./models/api/IImmutableProofVerifyRequest.js";
+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";
+export * from "./models/immutableProofTopics.js";
+export * from "./models/immutableProofTypes.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +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,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

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

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

@@ -0,0 +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"]}

package/dist/es/models/IImmutableProofComponent.js

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

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

@@ -0,0 +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 { 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/IImmutableProofVerification.js

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

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

@@ -0,0 +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"]}

package/dist/es/models/api/IImmutableProofCreateRequest.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Create a proof.\n */\nexport interface IImmutableProofCreateRequest {\n\t/**\n\t * The parameters from the body.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The document to create the proof for.\n\t\t */\n\t\tdocument: IJsonLdNodeObject;\n\t};\n}\n"]}

package/dist/es/models/api/IImmutableProofGetRequest.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Get a proof.\n */\nexport interface IImmutableProofGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the immutable proof to get.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

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

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

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

@@ -0,0 +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 { 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/api/IImmutableProofVerifyRequest.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofVerifyRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofVerifyRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Verify a proof.\n */\nexport interface IImmutableProofVerifyRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the immutable proof to verify.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IImmutableProofVerifyResponse.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofVerifyResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofVerifyResponse.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 { IImmutableProofVerification } from \"../IImmutableProofVerification.js\";\n\n/**\n * Response to verifying an immutable proof.\n */\nexport interface IImmutableProofVerifyResponse {\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: IImmutableProofVerification;\n}\n"]}

package/dist/es/models/eventBus/IImmutableProofEventBusProofCreated.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IImmutableProofEventBusProofCreated.js.map

package/dist/es/models/eventBus/IImmutableProofEventBusProofCreated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofEventBusProofCreated.js","sourceRoot":"","sources":["../../../../src/models/eventBus/IImmutableProofEventBusProofCreated.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Event bus payload for proof created.\n */\nexport interface IImmutableProofEventBusProofCreated {\n\t/**\n\t * The id of the proof created.\n\t */\n\tid: string;\n}\n"]}

package/dist/es/models/immutableProofContexts.js

@@ -0,0 +1,33 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofContexts = {
+    /**
+     * The canonical RDF namespace URI for Immutable Proof.
+     */
+    Namespace: "https://schema.twindev.org/immutable-proof/",
+    /**
+     * The value to use in context for Immutable Proof.
+     */
+    Context: "https://schema.twindev.org/immutable-proof/",
+    /**
+     * The JSON-LD Context URL for Immutable Proof.
+     */
+    JsonLdContext: "https://schema.twindev.org/immutable-proof/types.jsonld",
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    NamespaceCommon: "https://schema.twindev.org/common/",
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    ContextCommon: "https://schema.twindev.org/common/",
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld"
+};
+//# sourceMappingURL=immutableProofContexts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofContexts.js","sourceRoot":"","sources":["../../../src/models/immutableProofContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,6CAA6C;IAExD;;OAEG;IACH,OAAO,EAAE,6CAA6C;IAEtD;;OAEG;IACH,aAAa,EAAE,yDAAyD;IAExE;;OAEG;IACH,eAAe,EAAE,oCAAoC;IAErD;;OAEG;IACH,aAAa,EAAE,oCAAoC;IAEnD;;OAEG;IACH,mBAAmB,EAAE,gDAAgD;CAC5D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of immutable proof data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofContexts = {\n\t/**\n\t * The canonical RDF namespace URI for Immutable Proof.\n\t */\n\tNamespace: \"https://schema.twindev.org/immutable-proof/\",\n\n\t/**\n\t * The value to use in context for Immutable Proof.\n\t */\n\tContext: \"https://schema.twindev.org/immutable-proof/\",\n\n\t/**\n\t * The JSON-LD Context URL for Immutable Proof.\n\t */\n\tJsonLdContext: \"https://schema.twindev.org/immutable-proof/types.jsonld\",\n\n\t/**\n\t * The canonical RDF namespace URI for TWIN Common.\n\t */\n\tNamespaceCommon: \"https://schema.twindev.org/common/\",\n\n\t/**\n\t * The value to use in JSON-LD context for TWIN Common.\n\t */\n\tContextCommon: \"https://schema.twindev.org/common/\",\n\n\t/**\n\t * The JSON-LD Context URL for TWIN Common.\n\t */\n\tJsonLdContextCommon: \"https://schema.twindev.org/common/types.jsonld\"\n} as const;\n\n/**\n * The contexts of immutable proof data.\n */\nexport type ImmutableProofContexts =\n\t(typeof ImmutableProofContexts)[keyof typeof ImmutableProofContexts];\n"]}

package/dist/es/models/immutableProofFailure.js

@@ -0,0 +1,25 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The failure reason of the proof.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofFailure = {
+    /**
+     * Proof not yet issued.
+     */
+    NotIssued: "notIssued",
+    /**
+     * Proof missing.
+     */
+    ProofMissing: "proofMissing",
+    /**
+     * Verification failure.
+     */
+    VerificationFailure: "verificationFailure",
+    /**
+     * Revoked.
+     */
+    Revoked: "revoked"
+};
+//# sourceMappingURL=immutableProofFailure.js.map

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

@@ -0,0 +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,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/immutableProofTopics.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The topics for immutable proof event bus notifications.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofTopics = {
+    /**
+     * A proof was created.
+     */
+    ProofCreated: "immutable-proof:proof-created"
+};
+//# sourceMappingURL=immutableProofTopics.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofTopics.js","sourceRoot":"","sources":["../../../src/models/immutableProofTopics.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,oBAAoB,GAAG;IACnC;;OAEG;IACH,YAAY,EAAE,+BAA+B;CACpC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The topics for immutable proof event bus notifications.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofTopics = {\n\t/**\n\t * A proof was created.\n\t */\n\tProofCreated: \"immutable-proof:proof-created\"\n} as const;\n\n/**\n * The topics for immutable proof event bus notifications.\n */\nexport type ImmutableProofTopics = (typeof ImmutableProofTopics)[keyof typeof ImmutableProofTopics];\n"]}

package/dist/es/models/immutableProofTypes.js

@@ -0,0 +1,21 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofTypes = {
+    /**
+     * Represents Immutable Proof.
+     */
+    ImmutableProof: "ImmutableProof",
+    /**
+     * Represents Immutable Proof Receipt.
+     */
+    ImmutableProofReceipt: "ImmutableProofReceipt",
+    /**
+     * Represents Immutable Proof Verification.
+     */
+    ImmutableProofVerification: "ImmutableProofVerification"
+};
+//# sourceMappingURL=immutableProofTypes.js.map

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

@@ -0,0 +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"]}

package/dist/es/schemas/ImmutableProof.json

@@ -0,0 +1,40 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/immutable-proof/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/"
+                    }
+                ]
+            },
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "type": "string",
+            "const": "ImmutableProof",
+            "description": "JSON-LD Type."
+        },
+        "id": {
+            "type": "string",
+            "description": "The id of the object associated with the proof."
+        },
+        "proofIntegrity": {
+            "type": "string",
+            "description": "The integrity hash of the object associated with the proof. json-ld namespace:twin-common"
+        }
+    },
+    "required": [
+        "proofIntegrity"
+    ]
+}

package/dist/types/index.d.ts

@@ -1,14 +1,15 @@
-export * from "./dataTypes/immutableProofDataTypes";
-export * from "./models/api/IImmutableProofCreateRequest";
-export * from "./models/api/IImmutableProofGetRequest";
-export * from "./models/api/IImmutableProofGetResponse";
-export * from "./models/api/IImmutableProofVerifyRequest";
-export * from "./models/api/IImmutableProofVerifyResponse";
-export * from "./models/eventBus/IImmutableProofEventBusProofCreated";
-export * from "./models/IImmutableProof";
-export * from "./models/IImmutableProofComponent";
-export * from "./models/IImmutableProofVerification";
-export * from "./models/immutableProofContexts";
-export * from "./models/immutableProofFailure";
-export * from "./models/immutableProofTopics";
-export * from "./models/immutableProofTypes";
+export * from "./dataTypes/immutableProofDataTypes.js";
+export * from "./models/api/IImmutableProofCreateRequest.js";
+export * from "./models/api/IImmutableProofGetRequest.js";
+export * from "./models/api/IImmutableProofGetResponse.js";
+export * from "./models/api/IImmutableProofVerifyRequest.js";
+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";
+export * from "./models/immutableProofTopics.js";
+export * from "./models/immutableProofTypes.js";

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

@@ -1,7 +1,5 @@
-import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IDataIntegrityProof } from "@twin.org/standards-w3c-did";
-import type { ImmutableProofContexts } from "./immutableProofContexts";
-import type { ImmutableProofTypes } from "./immutableProofTypes";
+import type { ImmutableProofContexts } from "./immutableProofContexts.js";
+import type { ImmutableProofTypes } from "./immutableProofTypes.js";
 /**
  * Interface describing an immutable proof state.
  */
@@ -9,45 +7,18 @@ export interface IImmutableProof {
     /**
      * JSON-LD Context.
      */
-    "@context": [
-        typeof ImmutableProofContexts.ContextRoot,
-        typeof ImmutableProofContexts.ContextRootCommon,
-        ...IJsonLdContextDefinitionElement[]
-    ];
+    "@context"?: [typeof ImmutableProofContexts.Context, typeof ImmutableProofContexts.ContextCommon];
     /**
      * JSON-LD Type.
      */
-    type: typeof ImmutableProofTypes.ImmutableProof;
-    /**
-     * The id of the proof.
-     */
-    id: string;
-    /**
-     * The id of the node who created the proof.
-     */
-    nodeIdentity: string;
-    /**
-     * The id of the user who created the proof.
-     */
-    userIdentity: string;
+    type?: typeof ImmutableProofTypes.ImmutableProof;
     /**
      * The id of the object associated with the proof.
      */
-    proofObjectId?: string;
-    /**
-     * The hash of the object associated with the proof.
-     */
-    proofObjectHash: string;
-    /**
-     * The verifiable storage id for where the proof is stored.
-     */
-    verifiableStorageId?: string;
-    /**
-     * The proof which can be undefined if it has not yet been issued.
-     */
-    proof?: IDataIntegrityProof;
+    id?: string;
     /**
-     * The immutable receipt detail for where the proof is stored.
+     * 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,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 { IImmutableProofVerification } from "./IImmutableProofVerification";
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
+import type { IImmutableProofVerification } from "./IImmutableProofVerification.js";
 /**
  * Interface describing an immutable proof contract.
  */
@@ -9,18 +9,16 @@ export interface IImmutableProofComponent extends IComponent {
     /**
      * Create a new proof.
      * @param document The document to create the proof for.
-     * @param userIdentity The identity to create the immutable proof operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @returns The id of the new proof.
      */
-    create(document: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(document: IJsonLdNodeObject): Promise<string>;
     /**
      * Get a proof.
      * @param id The id of the proof to get.
      * @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.
@@ -31,9 +29,8 @@ export interface IImmutableProofComponent extends IComponent {
     /**
      * Remove the verifiable storage for the proof.
      * @param id The id of the proof to remove the storage from.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the proof is not found.
      */
-    removeVerifiable(id: string, nodeIdentity?: string): Promise<void>;
+    removeVerifiable(id: string): Promise<void>;
 }

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/IImmutableProofVerification.d.ts

@@ -1,6 +1,6 @@
-import type { ImmutableProofContexts } from "./immutableProofContexts";
-import type { ImmutableProofFailure } from "./immutableProofFailure";
-import type { ImmutableProofTypes } from "./immutableProofTypes";
+import type { ImmutableProofContexts } from "./immutableProofContexts.js";
+import type { ImmutableProofFailure } from "./immutableProofFailure.js";
+import type { ImmutableProofTypes } from "./immutableProofTypes.js";
 /**
  * Interface describing an immutable proof verification.
  */
@@ -8,17 +8,19 @@ export interface IImmutableProofVerification {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof ImmutableProofContexts.ContextRoot;
+    "@context": typeof ImmutableProofContexts.Context;
     /**
      * JSON-LD Type.
      */
     type: typeof ImmutableProofTypes.ImmutableProofVerification;
     /**
      * Was the verification successful.
+     * json-ld namespace:twin-common
      */
     verified: boolean;
     /**
      * If the verification was unsuccessful the failure reason.
+     * json-ld type:schema:Text
      */
     failure?: ImmutableProofFailure;
 }

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";
 /**
  * Response to getting an immutable proof.
  */
@@ -13,5 +13,5 @@ export interface IImmutableProofGetResponse {
     /**
      * The response body.
      */
-    body: IImmutableProof;
+    body: IDidVerifiableCredential;
 }

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

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IImmutableProofVerification } from "../IImmutableProofVerification";
+import type { IImmutableProofVerification } from "../IImmutableProofVerification.js";
 /**
  * Response to verifying an immutable proof.
  */

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

@@ -3,13 +3,29 @@
  */
 export declare const ImmutableProofContexts: {
     /**
-     * The context root for the immutable proof types.
+     * The canonical RDF namespace URI for Immutable Proof.
      */
-    readonly ContextRoot: "https://schema.twindev.org/immutable-proof/";
+    readonly Namespace: "https://schema.twindev.org/immutable-proof/";
     /**
-     * The context root for the common types.
+     * The value to use in context for Immutable Proof.
      */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+    readonly Context: "https://schema.twindev.org/immutable-proof/";
+    /**
+     * The JSON-LD Context URL for Immutable Proof.
+     */
+    readonly JsonLdContext: "https://schema.twindev.org/immutable-proof/types.jsonld";
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    readonly NamespaceCommon: "https://schema.twindev.org/common/";
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    readonly ContextCommon: "https://schema.twindev.org/common/";
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    readonly JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld";
 };
 /**
  * The contexts of immutable proof data.

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