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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Immutable Proof Models
+
+Models which define the structure of the immutable proof connectors and services.
+
+## Installation
+
+```shell
+npm install @twin.org/immutable-proof-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,138 @@
+'use strict';
+
+var dataCore = require('@twin.org/data-core');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofTypes = {
+    /**
+     * The context root for the immutable proof types.
+     */
+    ContextRoot: "https://schema.twindev.org/immutable-proof/",
+    /**
+     * Represents Immutable Proof.
+     */
+    ImmutableProof: "ImmutableProof"
+};
+
+var type = "object";
+var properties = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/immutable-proof/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/immutable-proof/"
+					}
+				],
+				additionalItems: {
+					type: "string"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "ImmutableProof",
+		description: "JSON-LD Type."
+	},
+	id: {
+		type: "string",
+		description: "The id of the proof."
+	},
+	userIdentity: {
+		type: "string",
+		description: "The id of the user who created the proof."
+	},
+	proofObjectId: {
+		type: "string",
+		description: "The id of the object associated with the proof."
+	},
+	proofObjectHash: {
+		type: "string",
+		description: "The hash of the object associated with the proof."
+	},
+	proof: {
+		$ref: "https://schema.twindev.org/did/DidProof",
+		description: "The proof which can be undefined if it has not yet been issued."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"userIdentity",
+	"proofObjectHash"
+];
+var additionalProperties = false;
+var description = "Interface describing an immutable proof state.";
+var ImmutableProofSchema = {
+	type: type,
+	properties: properties,
+	required: required,
+	additionalProperties: additionalProperties,
+	description: description
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Handle all the data types for immutable proof.
+ */
+class ImmutableProofDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes() {
+        dataCore.DataTypeHandlerFactory.register(ImmutableProofTypes.ImmutableProof, () => ({
+            type: ImmutableProofTypes.ImmutableProof,
+            defaultValue: {},
+            jsonSchema: async () => ImmutableProofSchema
+        }));
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The failure reason of the proof.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofFailure = {
+    /**
+     * Proof not yes issued.
+     */
+    NotIssued: "notIssued",
+    /**
+     * Proof missing.
+     */
+    ProofMissing: "proofMissing",
+    /**
+     * Crypto suite mismatch.
+     */
+    CryptoSuiteMismatch: "cryptoSuiteMismatch",
+    /**
+     * Proof type.
+     */
+    ProofTypeMismatch: "proofTypeMismatch",
+    /**
+     * Signature mismatch.
+     */
+    SignatureMismatch: "signatureMismatch"
+};
+
+exports.ImmutableProofDataTypes = ImmutableProofDataTypes;
+exports.ImmutableProofFailure = ImmutableProofFailure;
+exports.ImmutableProofTypes = ImmutableProofTypes;

package/dist/esm/index.mjs

@@ -0,0 +1,134 @@
+import { DataTypeHandlerFactory } from '@twin.org/data-core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofTypes = {
+    /**
+     * The context root for the immutable proof types.
+     */
+    ContextRoot: "https://schema.twindev.org/immutable-proof/",
+    /**
+     * Represents Immutable Proof.
+     */
+    ImmutableProof: "ImmutableProof"
+};
+
+var type = "object";
+var properties = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/immutable-proof/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/immutable-proof/"
+					}
+				],
+				additionalItems: {
+					type: "string"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "ImmutableProof",
+		description: "JSON-LD Type."
+	},
+	id: {
+		type: "string",
+		description: "The id of the proof."
+	},
+	userIdentity: {
+		type: "string",
+		description: "The id of the user who created the proof."
+	},
+	proofObjectId: {
+		type: "string",
+		description: "The id of the object associated with the proof."
+	},
+	proofObjectHash: {
+		type: "string",
+		description: "The hash of the object associated with the proof."
+	},
+	proof: {
+		$ref: "https://schema.twindev.org/did/DidProof",
+		description: "The proof which can be undefined if it has not yet been issued."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"userIdentity",
+	"proofObjectHash"
+];
+var additionalProperties = false;
+var description = "Interface describing an immutable proof state.";
+var ImmutableProofSchema = {
+	type: type,
+	properties: properties,
+	required: required,
+	additionalProperties: additionalProperties,
+	description: description
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Handle all the data types for immutable proof.
+ */
+class ImmutableProofDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes() {
+        DataTypeHandlerFactory.register(ImmutableProofTypes.ImmutableProof, () => ({
+            type: ImmutableProofTypes.ImmutableProof,
+            defaultValue: {},
+            jsonSchema: async () => ImmutableProofSchema
+        }));
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The failure reason of the proof.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofFailure = {
+    /**
+     * Proof not yes issued.
+     */
+    NotIssued: "notIssued",
+    /**
+     * Proof missing.
+     */
+    ProofMissing: "proofMissing",
+    /**
+     * Crypto suite mismatch.
+     */
+    CryptoSuiteMismatch: "cryptoSuiteMismatch",
+    /**
+     * Proof type.
+     */
+    ProofTypeMismatch: "proofTypeMismatch",
+    /**
+     * Signature mismatch.
+     */
+    SignatureMismatch: "signatureMismatch"
+};
+
+export { ImmutableProofDataTypes, ImmutableProofFailure, ImmutableProofTypes };

package/dist/types/dataTypes/immutableProofDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the data types for immutable proof.
+ */
+export declare class ImmutableProofDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,10 @@
+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/IImmutableProof";
+export * from "./models/IImmutableProofComponent";
+export * from "./models/immutableProofFailure";
+export * from "./models/immutableProofTypes";

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

@@ -0,0 +1,35 @@
+import type { IDidProof } from "@twin.org/standards-w3c-did";
+import type { ImmutableProofTypes } from "./immutableProofTypes";
+/**
+ * Interface describing an immutable proof state.
+ */
+export interface IImmutableProof {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof ImmutableProofTypes.ContextRoot | [typeof ImmutableProofTypes.ContextRoot, ...string[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof ImmutableProofTypes.ImmutableProof;
+    /**
+     * The id of the proof.
+     */
+    id: string;
+    /**
+     * The id of the user who created the proof.
+     */
+    userIdentity: string;
+    /**
+     * The id of the object associated with the proof.
+     */
+    proofObjectId?: string;
+    /**
+     * The hash of the object associated with the proof.
+     */
+    proofObjectHash: string;
+    /**
+     * The proof which can be undefined if it has not yet been issued.
+     */
+    proof?: IDidProof;
+}

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

@@ -0,0 +1,43 @@
+import type { IComponent } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IImmutableProof } from "./IImmutableProof";
+import type { ImmutableProofFailure } from "./immutableProofFailure";
+/**
+ * Interface describing an immutable proof contract.
+ */
+export interface IImmutableProofComponent extends IComponent {
+    /**
+     * Create a new authentication proof.
+     * @param proofObject The object for the proof as JSON-LD.
+     * @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 authentication proof.
+     */
+    create(proofObject: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    /**
+     * Get an authentication 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>;
+    /**
+     * Verify an authentication proof.
+     * @param id The id of the proof to verify.
+     * @param proofObject The object to verify as JSON-LD.
+     * @returns The result of the verification and any failures.
+     * @throws NotFoundError if the proof is not found.
+     */
+    verify(id: string, proofObject: IJsonLdNodeObject): Promise<{
+        verified: boolean;
+        failure?: ImmutableProofFailure;
+    }>;
+    /**
+     * Remove the immutable 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.
+     */
+    removeImmutable(id: string, nodeIdentity?: string): Promise<void>;
+}

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

@@ -0,0 +1,15 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Create a proof.
+ */
+export interface IImmutableProofCreateRequest {
+    /**
+     * The parameters from the body.
+     */
+    body: {
+        /**
+         * The proof object to create the proof for.
+         */
+        proofObject: IJsonLdNodeObject;
+    };
+}

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

@@ -0,0 +1,21 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Get a proof.
+ */
+export interface IImmutableProofGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the immutable proof to get.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IImmutableProof } from "../IImmutableProof";
+/**
+ * Response to getting an immutable proof.
+ */
+export interface IImmutableProofGetResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IImmutableProof;
+}

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

@@ -0,0 +1,24 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Verify a proof.
+ */
+export interface IImmutableProofVerifyRequest {
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the immutable proof to verify.
+         */
+        id: string;
+    };
+    /**
+     * The parameters from the body.
+     */
+    body: {
+        /**
+         * The proof object to verify.
+         */
+        proofObject: IJsonLdNodeObject;
+    };
+}

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

@@ -0,0 +1,19 @@
+import type { ImmutableProofFailure } from "../immutableProofFailure";
+/**
+ * Response to verifying an immutable proof.
+ */
+export interface IImmutableProofVerifyResponse {
+    /**
+     * The response body.
+     */
+    body: {
+        /**
+         * Was the proof verified.
+         */
+        verified: boolean;
+        /**
+         * If not verified what was the failure.
+         */
+        failure?: ImmutableProofFailure;
+    };
+}

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

@@ -0,0 +1,29 @@
+/**
+ * The failure reason of the proof.
+ */
+export declare const ImmutableProofFailure: {
+    /**
+     * Proof not yes issued.
+     */
+    readonly NotIssued: "notIssued";
+    /**
+     * Proof missing.
+     */
+    readonly ProofMissing: "proofMissing";
+    /**
+     * Crypto suite mismatch.
+     */
+    readonly CryptoSuiteMismatch: "cryptoSuiteMismatch";
+    /**
+     * Proof type.
+     */
+    readonly ProofTypeMismatch: "proofTypeMismatch";
+    /**
+     * Signature mismatch.
+     */
+    readonly SignatureMismatch: "signatureMismatch";
+};
+/**
+ * The failure reason of the proof.
+ */
+export type ImmutableProofFailure = (typeof ImmutableProofFailure)[keyof typeof ImmutableProofFailure];

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

@@ -0,0 +1,17 @@
+/**
+ * The types of immutable proof data.
+ */
+export declare const ImmutableProofTypes: {
+    /**
+     * The context root for the immutable proof types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/immutable-proof/";
+    /**
+     * Represents Immutable Proof.
+     */
+    readonly ImmutableProof: "ImmutableProof";
+};
+/**
+ * The types of immutable proof data.
+ */
+export type ImmutableProofTypes = (typeof ImmutableProofTypes)[keyof typeof ImmutableProofTypes];

package/docs/changelog.md

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

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/immutable-proof-models - Examples

package/docs/reference/classes/ImmutableProofDataTypes.md

@@ -0,0 +1,25 @@
+# Class: ImmutableProofDataTypes
+
+Handle all the data types for immutable proof.
+
+## Constructors
+
+### new ImmutableProofDataTypes()
+
+> **new ImmutableProofDataTypes**(): [`ImmutableProofDataTypes`](ImmutableProofDataTypes.md)
+
+#### Returns
+
+[`ImmutableProofDataTypes`](ImmutableProofDataTypes.md)
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,25 @@
+# @twin.org/immutable-proof-models
+
+## Classes
+
+- [ImmutableProofDataTypes](classes/ImmutableProofDataTypes.md)
+
+## Interfaces
+
+- [IImmutableProof](interfaces/IImmutableProof.md)
+- [IImmutableProofComponent](interfaces/IImmutableProofComponent.md)
+- [IImmutableProofCreateRequest](interfaces/IImmutableProofCreateRequest.md)
+- [IImmutableProofGetRequest](interfaces/IImmutableProofGetRequest.md)
+- [IImmutableProofGetResponse](interfaces/IImmutableProofGetResponse.md)
+- [IImmutableProofVerifyRequest](interfaces/IImmutableProofVerifyRequest.md)
+- [IImmutableProofVerifyResponse](interfaces/IImmutableProofVerifyResponse.md)
+
+## Type Aliases
+
+- [ImmutableProofFailure](type-aliases/ImmutableProofFailure.md)
+- [ImmutableProofTypes](type-aliases/ImmutableProofTypes.md)
+
+## Variables
+
+- [ImmutableProofFailure](variables/ImmutableProofFailure.md)
+- [ImmutableProofTypes](variables/ImmutableProofTypes.md)

package/docs/reference/interfaces/IImmutableProof.md

@@ -0,0 +1,59 @@
+# Interface: IImmutableProof
+
+Interface describing an immutable proof state.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/immutable-proof/"` \| [`"https://schema.twindev.org/immutable-proof/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"ImmutableProof"`
+
+JSON-LD Type.
+
+***
+
+### id
+
+> **id**: `string`
+
+The id of the proof.
+
+***
+
+### userIdentity
+
+> **userIdentity**: `string`
+
+The id of the user who created the proof.
+
+***
+
+### proofObjectId?
+
+> `optional` **proofObjectId**: `string`
+
+The id of the object associated with the proof.
+
+***
+
+### proofObjectHash
+
+> **proofObjectHash**: `string`
+
+The hash of the object associated with the proof.
+
+***
+
+### proof?
+
+> `optional` **proof**: `IDidProof`
+
+The proof which can be undefined if it has not yet been issued.

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -0,0 +1,123 @@
+# Interface: IImmutableProofComponent
+
+Interface describing an immutable proof contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create()
+
+> **create**(`proofObject`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+
+Create a new authentication proof.
+
+#### Parameters
+
+• **proofObject**: `IJsonLdNodeObject`
+
+The object for the proof as JSON-LD.
+
+• **userIdentity?**: `string`
+
+The identity to create the immutable proof operation with.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the new authentication proof.
+
+***
+
+### get()
+
+> **get**(`id`): `Promise`\<[`IImmutableProof`](IImmutableProof.md)\>
+
+Get an authentication proof.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the proof to get.
+
+#### Returns
+
+`Promise`\<[`IImmutableProof`](IImmutableProof.md)\>
+
+The proof.
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+***
+
+### verify()
+
+> **verify**(`id`, `proofObject`): `Promise`\<`object`\>
+
+Verify an authentication proof.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the proof to verify.
+
+• **proofObject**: `IJsonLdNodeObject`
+
+The object to verify as JSON-LD.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The result of the verification and any failures.
+
+##### verified
+
+> **verified**: `boolean`
+
+##### failure?
+
+> `optional` **failure**: [`ImmutableProofFailure`](../type-aliases/ImmutableProofFailure.md)
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+***
+
+### removeImmutable()
+
+> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+
+Remove the immutable storage for the proof.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the proof to remove the storage from.
+
+• **nodeIdentity?**: `string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+NotFoundError if the proof is not found.

package/docs/reference/interfaces/IImmutableProofCreateRequest.md

@@ -0,0 +1,17 @@
+# Interface: IImmutableProofCreateRequest
+
+Create a proof.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The parameters from the body.
+
+#### proofObject
+
+> **proofObject**: `IJsonLdNodeObject`
+
+The proof object to create the proof for.

package/docs/reference/interfaces/IImmutableProofGetRequest.md

@@ -0,0 +1,29 @@
+# Interface: IImmutableProofGetRequest
+
+Get a proof.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the immutable proof to get.

package/docs/reference/interfaces/IImmutableProofGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IImmutableProofGetResponse
+
+Response to getting an immutable proof.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body
+
+> **body**: [`IImmutableProof`](IImmutableProof.md)
+
+The response body.

package/docs/reference/interfaces/IImmutableProofVerifyRequest.md

@@ -0,0 +1,31 @@
+# Interface: IImmutableProofVerifyRequest
+
+Verify a proof.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the immutable proof to verify.
+
+***
+
+### body
+
+> **body**: `object`
+
+The parameters from the body.
+
+#### proofObject
+
+> **proofObject**: `IJsonLdNodeObject`
+
+The proof object to verify.

package/docs/reference/interfaces/IImmutableProofVerifyResponse.md

@@ -0,0 +1,23 @@
+# Interface: IImmutableProofVerifyResponse
+
+Response to verifying an immutable proof.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response body.
+
+#### verified
+
+> **verified**: `boolean`
+
+Was the proof verified.
+
+#### failure?
+
+> `optional` **failure**: [`ImmutableProofFailure`](../type-aliases/ImmutableProofFailure.md)
+
+If not verified what was the failure.

package/docs/reference/type-aliases/ImmutableProofFailure.md

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofFailure
+
+> **ImmutableProofFailure**: *typeof* [`ImmutableProofFailure`](../variables/ImmutableProofFailure.md)\[keyof *typeof* [`ImmutableProofFailure`](../variables/ImmutableProofFailure.md)\]
+
+The failure reason of the proof.

package/docs/reference/type-aliases/ImmutableProofTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofTypes
+
+> **ImmutableProofTypes**: *typeof* [`ImmutableProofTypes`](../variables/ImmutableProofTypes.md)\[keyof *typeof* [`ImmutableProofTypes`](../variables/ImmutableProofTypes.md)\]
+
+The types of immutable proof data.

package/docs/reference/variables/ImmutableProofFailure.md

@@ -0,0 +1,37 @@
+# Variable: ImmutableProofFailure
+
+> `const` **ImmutableProofFailure**: `object`
+
+The failure reason of the proof.
+
+## Type declaration
+
+### NotIssued
+
+> `readonly` **NotIssued**: `"notIssued"` = `"notIssued"`
+
+Proof not yes issued.
+
+### ProofMissing
+
+> `readonly` **ProofMissing**: `"proofMissing"` = `"proofMissing"`
+
+Proof missing.
+
+### CryptoSuiteMismatch
+
+> `readonly` **CryptoSuiteMismatch**: `"cryptoSuiteMismatch"` = `"cryptoSuiteMismatch"`
+
+Crypto suite mismatch.
+
+### ProofTypeMismatch
+
+> `readonly` **ProofTypeMismatch**: `"proofTypeMismatch"` = `"proofTypeMismatch"`
+
+Proof type.
+
+### SignatureMismatch
+
+> `readonly` **SignatureMismatch**: `"signatureMismatch"` = `"signatureMismatch"`
+
+Signature mismatch.

package/docs/reference/variables/ImmutableProofTypes.md

@@ -0,0 +1,19 @@
+# Variable: ImmutableProofTypes
+
+> `const` **ImmutableProofTypes**: `object`
+
+The types of immutable proof data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
+
+The context root for the immutable proof types.
+
+### ImmutableProof
+
+> `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`
+
+Represents Immutable Proof.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@twin.org/immutable-proof-models",
+	"version": "0.0.1-next.1",
+	"description": "Models which define the structure of the immutable proof connectors and services",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/immutable-proof.git",
+		"directory": "packages/immutable-proof-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}