@twin.org/attestation-models 0.0.1-next.3

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 Attestation Models
+
+Models which define the structure of the attestation contracts and connectors.
+
+## Installation
+
+```shell
+npm install @twin.org/attestation-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,13 @@
+'use strict';
+
+var core = require('@twin.org/core');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating attestation connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AttestationConnectorFactory = core.Factory.createFactory("attestation");
+
+exports.AttestationConnectorFactory = AttestationConnectorFactory;

package/dist/esm/index.mjs

@@ -0,0 +1,11 @@
+import { Factory } from '@twin.org/core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating attestation connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AttestationConnectorFactory = Factory.createFactory("attestation");
+
+export { AttestationConnectorFactory };

package/dist/types/factories/attestationConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IAttestationConnector } from "../models/IAttestationConnector";
+/**
+ * Factory for creating attestation connectors.
+ */
+export declare const AttestationConnectorFactory: Factory<IAttestationConnector>;

package/dist/types/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./factories/attestationConnectorFactory";
+export * from "./models/IAttestationComponent";
+export * from "./models/IAttestationConnector";
+export * from "./models/IAttestationInformation";
+export * from "./models/IAttestationProof";
+export * from "./models/api/IAttestationAttestRequest";
+export * from "./models/api/IAttestationAttestResponse";
+export * from "./models/api/IAttestationDestroyRequest";
+export * from "./models/api/IAttestationTransferRequest";
+export * from "./models/api/IAttestationTransferResponse";
+export * from "./models/api/IAttestationVerifyRequest";
+export * from "./models/api/IAttestationVerifyResponse";

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

@@ -0,0 +1,42 @@
+import type { IComponent } from "@twin.org/core";
+import type { IAttestationInformation } from "./IAttestationInformation";
+/**
+ * Interface describing an attestation contract.
+ */
+export interface IAttestationComponent extends IComponent {
+    /**
+     * Attest the data and return the collated information.
+     * @param verificationMethodId The identity verification method to use for attesting the data.
+     * @param data The data to attest.
+     * @param namespace The namespace of the connector to use for the attestation, defaults to component configured namespace.
+     * @param identity The identity to perform the attestation operation with.
+     * @param nodeIdentity The node identity to include in the attestation.
+     * @returns The collated attestation data.
+     */
+    attest<T = unknown>(verificationMethodId: string, data: T, namespace?: string, identity?: string, nodeIdentity?: string): Promise<IAttestationInformation<T>>;
+    /**
+     * Resolve and verify the attestation id.
+     * @param attestationId The attestation id to verify.
+     * @returns The verified attestation details.
+     */
+    verify<T = unknown>(attestationId: string): Promise<{
+        verified: boolean;
+        failure?: string;
+        information?: Partial<IAttestationInformation<T>>;
+    }>;
+    /**
+     * Transfer the attestation to a new holder.
+     * @param attestationId The attestation to transfer.
+     * @param holderIdentity The identity to transfer the attestation to.
+     * @param identity The identity to perform the attestation operation with.
+     * @returns The updated attestation details.
+     */
+    transfer<T = unknown>(attestationId: string, holderIdentity: string, identity?: string): Promise<IAttestationInformation<T>>;
+    /**
+     * Destroy the attestation.
+     * @param attestationId The attestation to transfer.
+     * @param identity The identity to perform the attestation operation with.
+     * @returns The updated attestation details.
+     */
+    destroy(attestationId: string, identity?: string): Promise<void>;
+}

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

@@ -0,0 +1,42 @@
+import type { IComponent } from "@twin.org/core";
+import type { IAttestationInformation } from "./IAttestationInformation";
+/**
+ * Interface describing an attestation connector.
+ */
+export interface IAttestationConnector extends IComponent {
+    /**
+     * Attest the data and return the collated information.
+     * @param controller The controller identity of the user to access the vault keys.
+     * @param address The controller address for the attestation.
+     * @param verificationMethodId The identity verification method to use for attesting the data.
+     * @param data The data to attest.
+     * @returns The collated attestation data.
+     */
+    attest<T = unknown>(controller: string, address: string, verificationMethodId: string, data: T): Promise<IAttestationInformation<T>>;
+    /**
+     * Resolve and verify the attestation id.
+     * @param attestationId The attestation id to verify.
+     * @returns The verified attestation details.
+     */
+    verify<T = unknown>(attestationId: string): Promise<{
+        verified: boolean;
+        failure?: string;
+        information?: Partial<IAttestationInformation<T>>;
+    }>;
+    /**
+     * Transfer the attestation to a new holder.
+     * @param controller The controller identity of the user to access the vault keys.
+     * @param attestationId The attestation to transfer.
+     * @param holderIdentity The holder identity of the attestation.
+     * @param holderAddress The new controller address of the attestation belonging to the holder.
+     * @returns The updated attestation details.
+     */
+    transfer<T = unknown>(controller: string, attestationId: string, holderIdentity: string, holderAddress: string): Promise<IAttestationInformation<T>>;
+    /**
+     * Destroy the attestation.
+     * @param controller The controller identity of the user to access the vault keys.
+     * @param attestationId The attestation to destroy.
+     * @returns Nothing.
+     */
+    destroy(controller: string, attestationId: string): Promise<void>;
+}

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

@@ -0,0 +1,34 @@
+import type { IAttestationProof } from "./IAttestationProof";
+/**
+ * Interface describing the collated attestation information.
+ */
+export interface IAttestationInformation<T = unknown> {
+    /**
+     * The unique identifier of the attestation.
+     */
+    id: string;
+    /**
+     * Created date/time of the attestation in ISO format.
+     */
+    created: string;
+    /**
+     * The identity of the owner.
+     */
+    ownerIdentity: string;
+    /**
+     * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
+     */
+    transferred?: string;
+    /**
+     * The identity of the current holder, can be undefined if owner is still the holder.
+     */
+    holderIdentity?: string;
+    /**
+     * The data that was attested.
+     */
+    data: T;
+    /**
+     * The proof for the attested data.
+     */
+    proof: IAttestationProof;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Interface describing an attestation proof.
+ */
+export interface IAttestationProof {
+    /**
+     * The type of the proof.
+     */
+    type: string;
+    /**
+     * The value of the proof.
+     */
+    value: string;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * Attest the data and return the collated attestation details.
+ */
+export interface IAttestationAttestRequest {
+    /**
+     * The data to be used in the signing.
+     */
+    body: {
+        /**
+         * The identity verification method to use for attesting the data.
+         */
+        verificationMethodId: string;
+        /**
+         * The data object to attest.
+         */
+        data: unknown;
+        /**
+         * The namespace of the connector to use for the attestation, defaults to component configured namespace.
+         */
+        namespace?: string;
+    };
+}

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

@@ -0,0 +1,12 @@
+import type { IAttestationInformation } from "../IAttestationInformation";
+/**
+ * The response when creating the attestation for some data.
+ */
+export interface IAttestationAttestResponse {
+    /**
+     * The result of the attestation process.
+     */
+    body: {
+        information: IAttestationInformation;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Destroy the attestation.
+ */
+export interface IAttestationDestroyRequest {
+    /**
+     * The parameters to be used in the destruction.
+     */
+    pathParams: {
+        /**
+         * The attestation id to destroy.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,23 @@
+/**
+ * Transfer the attestation to a new holder.
+ */
+export interface IAttestationTransferRequest {
+    /**
+     * The parameters to be used in the transfer.
+     */
+    pathParams: {
+        /**
+         * The attestation id to verify.
+         */
+        id: string;
+    };
+    /**
+     * The parameters to be used in the transfer.
+     */
+    body: {
+        /**
+         * The new holder identity.
+         */
+        holderIdentity: string;
+    };
+}

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

@@ -0,0 +1,15 @@
+import type { IAttestationInformation } from "../IAttestationInformation";
+/**
+ * The response to transferring the attestation.
+ */
+export interface IAttestationTransferResponse {
+    /**
+     * The data returned from the transfer response.
+     */
+    body: {
+        /**
+         * The updated attestation information.
+         */
+        information: IAttestationInformation;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Verify that the proof is valid for the attestation.
+ */
+export interface IAttestationVerifyRequest {
+    /**
+     * The parameters to be used in the verification.
+     */
+    pathParams: {
+        /**
+         * The attestation id to verify.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,23 @@
+import type { IAttestationInformation } from "../IAttestationInformation";
+/**
+ * The response to verifying the attestation.
+ */
+export interface IAttestationVerifyResponse {
+    /**
+     * The data returned from the verification response.
+     */
+    body: {
+        /**
+         * Whether the attestation is verified.
+         */
+        verified: boolean;
+        /**
+         * The failure message if the attestation is not verified.
+         */
+        failure?: string;
+        /**
+         * The attestation information.
+         */
+        information?: Partial<IAttestationInformation>;
+    };
+}

package/docs/changelog.md

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

package/docs/examples.md

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

package/docs/reference/index.md

@@ -0,0 +1,19 @@
+# @twin.org/attestation-models
+
+## Interfaces
+
+- [IAttestationComponent](interfaces/IAttestationComponent.md)
+- [IAttestationConnector](interfaces/IAttestationConnector.md)
+- [IAttestationInformation](interfaces/IAttestationInformation.md)
+- [IAttestationProof](interfaces/IAttestationProof.md)
+- [IAttestationAttestRequest](interfaces/IAttestationAttestRequest.md)
+- [IAttestationAttestResponse](interfaces/IAttestationAttestResponse.md)
+- [IAttestationDestroyRequest](interfaces/IAttestationDestroyRequest.md)
+- [IAttestationTransferRequest](interfaces/IAttestationTransferRequest.md)
+- [IAttestationTransferResponse](interfaces/IAttestationTransferResponse.md)
+- [IAttestationVerifyRequest](interfaces/IAttestationVerifyRequest.md)
+- [IAttestationVerifyResponse](interfaces/IAttestationVerifyResponse.md)
+
+## Variables
+
+- [AttestationConnectorFactory](variables/AttestationConnectorFactory.md)

package/docs/reference/interfaces/IAttestationAttestRequest.md

@@ -0,0 +1,29 @@
+# Interface: IAttestationAttestRequest
+
+Attest the data and return the collated attestation details.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The data to be used in the signing.
+
+#### verificationMethodId
+
+> **verificationMethodId**: `string`
+
+The identity verification method to use for attesting the data.
+
+#### data
+
+> **data**: `unknown`
+
+The data object to attest.
+
+#### namespace?
+
+> `optional` **namespace**: `string`
+
+The namespace of the connector to use for the attestation, defaults to component configured namespace.

package/docs/reference/interfaces/IAttestationAttestResponse.md

@@ -0,0 +1,15 @@
+# Interface: IAttestationAttestResponse
+
+The response when creating the attestation for some data.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The result of the attestation process.
+
+#### information
+
+> **information**: [`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>

package/docs/reference/interfaces/IAttestationComponent.md

@@ -0,0 +1,139 @@
+# Interface: IAttestationComponent
+
+Interface describing an attestation contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### attest()
+
+> **attest**\<`T`\>(`verificationMethodId`, `data`, `namespace`?, `identity`?, `nodeIdentity`?): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+Attest the data and return the collated information.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **verificationMethodId**: `string`
+
+The identity verification method to use for attesting the data.
+
+• **data**: `T`
+
+The data to attest.
+
+• **namespace?**: `string`
+
+The namespace of the connector to use for the attestation, defaults to component configured namespace.
+
+• **identity?**: `string`
+
+The identity to perform the attestation operation with.
+
+• **nodeIdentity?**: `string`
+
+The node identity to include in the attestation.
+
+#### Returns
+
+`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+The collated attestation data.
+
+***
+
+### verify()
+
+> **verify**\<`T`\>(`attestationId`): `Promise`\<`object`\>
+
+Resolve and verify the attestation id.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **attestationId**: `string`
+
+The attestation id to verify.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The verified attestation details.
+
+##### verified
+
+> **verified**: `boolean`
+
+##### failure?
+
+> `optional` **failure**: `string`
+
+##### information?
+
+> `optional` **information**: `Partial`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+***
+
+### transfer()
+
+> **transfer**\<`T`\>(`attestationId`, `holderIdentity`, `identity`?): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+Transfer the attestation to a new holder.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **attestationId**: `string`
+
+The attestation to transfer.
+
+• **holderIdentity**: `string`
+
+The identity to transfer the attestation to.
+
+• **identity?**: `string`
+
+The identity to perform the attestation operation with.
+
+#### Returns
+
+`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+The updated attestation details.
+
+***
+
+### destroy()
+
+> **destroy**(`attestationId`, `identity`?): `Promise`\<`void`\>
+
+Destroy the attestation.
+
+#### Parameters
+
+• **attestationId**: `string`
+
+The attestation to transfer.
+
+• **identity?**: `string`
+
+The identity to perform the attestation operation with.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+The updated attestation details.

package/docs/reference/interfaces/IAttestationConnector.md

@@ -0,0 +1,139 @@
+# Interface: IAttestationConnector
+
+Interface describing an attestation connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### attest()
+
+> **attest**\<`T`\>(`controller`, `address`, `verificationMethodId`, `data`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+Attest the data and return the collated information.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller identity of the user to access the vault keys.
+
+• **address**: `string`
+
+The controller address for the attestation.
+
+• **verificationMethodId**: `string`
+
+The identity verification method to use for attesting the data.
+
+• **data**: `T`
+
+The data to attest.
+
+#### Returns
+
+`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+The collated attestation data.
+
+***
+
+### verify()
+
+> **verify**\<`T`\>(`attestationId`): `Promise`\<`object`\>
+
+Resolve and verify the attestation id.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **attestationId**: `string`
+
+The attestation id to verify.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The verified attestation details.
+
+##### verified
+
+> **verified**: `boolean`
+
+##### failure?
+
+> `optional` **failure**: `string`
+
+##### information?
+
+> `optional` **information**: `Partial`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+***
+
+### transfer()
+
+> **transfer**\<`T`\>(`controller`, `attestationId`, `holderIdentity`, `holderAddress`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+Transfer the attestation to a new holder.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller identity of the user to access the vault keys.
+
+• **attestationId**: `string`
+
+The attestation to transfer.
+
+• **holderIdentity**: `string`
+
+The holder identity of the attestation.
+
+• **holderAddress**: `string`
+
+The new controller address of the attestation belonging to the holder.
+
+#### Returns
+
+`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+
+The updated attestation details.
+
+***
+
+### destroy()
+
+> **destroy**(`controller`, `attestationId`): `Promise`\<`void`\>
+
+Destroy the attestation.
+
+#### Parameters
+
+• **controller**: `string`
+
+The controller identity of the user to access the vault keys.
+
+• **attestationId**: `string`
+
+The attestation to destroy.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IAttestationDestroyRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAttestationDestroyRequest
+
+Destroy the attestation.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters to be used in the destruction.
+
+#### id
+
+> **id**: `string`
+
+The attestation id to destroy.

package/docs/reference/interfaces/IAttestationInformation.md

@@ -0,0 +1,63 @@
+# Interface: IAttestationInformation\<T\>
+
+Interface describing the collated attestation information.
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The unique identifier of the attestation.
+
+***
+
+### created
+
+> **created**: `string`
+
+Created date/time of the attestation in ISO format.
+
+***
+
+### ownerIdentity
+
+> **ownerIdentity**: `string`
+
+The identity of the owner.
+
+***
+
+### transferred?
+
+> `optional` **transferred**: `string`
+
+Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
+
+***
+
+### holderIdentity?
+
+> `optional` **holderIdentity**: `string`
+
+The identity of the current holder, can be undefined if owner is still the holder.
+
+***
+
+### data
+
+> **data**: `T`
+
+The data that was attested.
+
+***
+
+### proof
+
+> **proof**: [`IAttestationProof`](IAttestationProof.md)
+
+The proof for the attested data.

package/docs/reference/interfaces/IAttestationProof.md

@@ -0,0 +1,19 @@
+# Interface: IAttestationProof
+
+Interface describing an attestation proof.
+
+## Properties
+
+### type
+
+> **type**: `string`
+
+The type of the proof.
+
+***
+
+### value
+
+> **value**: `string`
+
+The value of the proof.

package/docs/reference/interfaces/IAttestationTransferRequest.md

@@ -0,0 +1,31 @@
+# Interface: IAttestationTransferRequest
+
+Transfer the attestation to a new holder.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters to be used in the transfer.
+
+#### id
+
+> **id**: `string`
+
+The attestation id to verify.
+
+***
+
+### body
+
+> **body**: `object`
+
+The parameters to be used in the transfer.
+
+#### holderIdentity
+
+> **holderIdentity**: `string`
+
+The new holder identity.

package/docs/reference/interfaces/IAttestationTransferResponse.md

@@ -0,0 +1,17 @@
+# Interface: IAttestationTransferResponse
+
+The response to transferring the attestation.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The data returned from the transfer response.
+
+#### information
+
+> **information**: [`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>
+
+The updated attestation information.

package/docs/reference/interfaces/IAttestationVerifyRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAttestationVerifyRequest
+
+Verify that the proof is valid for the attestation.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters to be used in the verification.
+
+#### id
+
+> **id**: `string`
+
+The attestation id to verify.

package/docs/reference/interfaces/IAttestationVerifyResponse.md

@@ -0,0 +1,29 @@
+# Interface: IAttestationVerifyResponse
+
+The response to verifying the attestation.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The data returned from the verification response.
+
+#### verified
+
+> **verified**: `boolean`
+
+Whether the attestation is verified.
+
+#### failure?
+
+> `optional` **failure**: `string`
+
+The failure message if the attestation is not verified.
+
+#### information?
+
+> `optional` **information**: `Partial`\<[`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>\>
+
+The attestation information.

package/docs/reference/variables/AttestationConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: AttestationConnectorFactory
+
+> `const` **AttestationConnectorFactory**: `Factory`\<[`IAttestationConnector`](../interfaces/IAttestationConnector.md)\>
+
+Factory for creating attestation connectors.

package/locales/en.json

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

package/package.json

@@ -0,0 +1,66 @@
+{
+	"name": "@twin.org/attestation-models",
+	"version": "0.0.1-next.3",
+	"description": "Models which define the structure of the attestation connectors and services",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/attestation.git",
+		"directory": "packages/attestation-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-did": "next"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.22.0",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"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"
+	]
+}