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

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

@@ -0,0 +1,21 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Verify that the proof is valid for the attestation.
+ */
+export interface IAttestationGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters to be used in the verification.
+     */
+    pathParams: {
+        /**
+         * The attestation id to verify.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAttestationInformation } from "../IAttestationInformation";
+/**
+ * The response to verifying the attestation.
+ */
+export interface IAttestationGetResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The data returned from the verification response.
+     */
+    body: IAttestationInformation;
+}

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

@@ -7,7 +7,7 @@ export interface IAttestationTransferRequest {
      */
     pathParams: {
         /**
-         * The attestation id to verify.
+         * The attestation id to transfer.
          */
         id: string;
     };
@@ -19,5 +19,9 @@ export interface IAttestationTransferRequest {
          * The new holder identity.
          */
         holderIdentity: string;
+        /**
+         * The new holder address.
+         */
+        holderAddress: string;
     };
 }

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts of attestation data.
+ */
+export declare const AttestationContexts: {
+    /**
+     * The context root for the attestation types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/attestation/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of attestation data.
+ */
+export type AttestationContexts = (typeof AttestationContexts)[keyof typeof AttestationContexts];

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

@@ -0,0 +1,17 @@
+/**
+ * The types of attestation data.
+ */
+export declare const AttestationTypes: {
+    /**
+     * Represents attestation information.
+     */
+    readonly Information: "Information";
+    /**
+     * Represents attestation JWT proof.
+     */
+    readonly JwtProof: "JwtProof";
+};
+/**
+ * The types of attestation data.
+ */
+export type AttestationTypes = (typeof AttestationTypes)[keyof typeof AttestationTypes];

package/docs/changelog.md

@@ -1,5 +1,47 @@
 # @twin.org/attestation-models - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.30](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.29...attestation-models-v0.0.1-next.30) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([1d96d2e](https://github.com/twinfoundation/attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
+
+## [0.0.1-next.29](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.28...attestation-models-v0.0.1-next.29) (2025-06-03)
+
+
+### Features
+
+* update ts-to-schema generation ([0f23298](https://github.com/twinfoundation/attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
+
+## [0.0.1-next.28](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.27...attestation-models-v0.0.1-next.28) (2025-05-28)
+
+
+### Features
+
+* update data type registration with fully qualified names ([5982245](https://github.com/twinfoundation/attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
+
+## [0.0.1-next.27](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.26...attestation-models-v0.0.1-next.27) (2025-05-06)
+
+
+### Miscellaneous Chores
+
+* **attestation-models:** Synchronize repo versions
+
+## [0.0.1-next.26](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.25...attestation-models-v0.0.1-next.26) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#5](https://github.com/twinfoundation/attestation/issues/5)) ([3768cf7](https://github.com/twinfoundation/attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
+
+## [0.0.1-next.25](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.24...attestation-models-v0.0.1-next.25) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **attestation-models:** Synchronize repo versions
+
+## v0.0.1-next.24
 
 - Initial Release

package/docs/reference/classes/AttestationDataTypes.md

@@ -0,0 +1,25 @@
+# Class: AttestationDataTypes
+
+Handle all the data types for attestation.
+
+## Constructors
+
+### Constructor
+
+> **new AttestationDataTypes**(): `AttestationDataTypes`
+
+#### Returns
+
+`AttestationDataTypes`
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -1,19 +1,28 @@
 # @twin.org/attestation-models
 
+## Classes
+
+- [AttestationDataTypes](classes/AttestationDataTypes.md)
+
 ## 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)
+- [IAttestationJwtProof](interfaces/IAttestationJwtProof.md)
+- [IAttestationCreateRequest](interfaces/IAttestationCreateRequest.md)
 - [IAttestationDestroyRequest](interfaces/IAttestationDestroyRequest.md)
+- [IAttestationGetRequest](interfaces/IAttestationGetRequest.md)
+- [IAttestationGetResponse](interfaces/IAttestationGetResponse.md)
 - [IAttestationTransferRequest](interfaces/IAttestationTransferRequest.md)
-- [IAttestationTransferResponse](interfaces/IAttestationTransferResponse.md)
-- [IAttestationVerifyRequest](interfaces/IAttestationVerifyRequest.md)
-- [IAttestationVerifyResponse](interfaces/IAttestationVerifyResponse.md)
+
+## Type Aliases
+
+- [AttestationContexts](type-aliases/AttestationContexts.md)
+- [AttestationTypes](type-aliases/AttestationTypes.md)
 
 ## Variables
 
 - [AttestationConnectorFactory](variables/AttestationConnectorFactory.md)
+- [AttestationContexts](variables/AttestationContexts.md)
+- [AttestationTypes](variables/AttestationTypes.md)

package/docs/reference/interfaces/IAttestationComponent.md

@@ -8,127 +8,125 @@ Interface describing an attestation contract.
 
 ## Methods
 
-### attest()
+### create()
 
-> **attest**\<`T`\>(`verificationMethodId`, `data`, `namespace`?, `identity`?, `nodeIdentity`?): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+> **create**(`attestationObject`, `namespace?`, `identity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
 Attest the data and return the collated information.
 
-#### Type Parameters
-
-• **T** = `unknown`
-
 #### Parameters
 
-• **verificationMethodId**: `string`
+##### attestationObject
 
-The identity verification method to use for attesting the data.
-
-• **data**: `T`
+`IJsonLdNodeObject`
 
 The data to attest.
 
-• **namespace?**: `string`
+##### namespace?
+
+`string`
 
 The namespace of the connector to use for the attestation, defaults to component configured namespace.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the attestation operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to include in the attestation.
 
 #### Returns
 
-`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+`Promise`\<`string`\>
 
-The collated attestation data.
+The id of the attestation.
 
 ***
 
-### verify()
+### get()
 
-> **verify**\<`T`\>(`attestationId`): `Promise`\<`object`\>
+> **get**(`id`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
 
 Resolve and verify the attestation id.
 
-#### Type Parameters
-
-• **T** = `unknown`
-
 #### Parameters
 
-• **attestationId**: `string`
+##### id
+
+`string`
 
 The attestation id to verify.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
 
 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**(`attestationId`, `holderIdentity`, `holderAddress`, `identity?`): `Promise`\<`void`\>
 
 Transfer the attestation to a new holder.
 
-#### Type Parameters
-
-• **T** = `unknown`
-
 #### Parameters
 
-• **attestationId**: `string`
+##### attestationId
+
+`string`
 
 The attestation to transfer.
 
-• **holderIdentity**: `string`
+##### holderIdentity
+
+`string`
 
 The identity to transfer the attestation to.
 
-• **identity?**: `string`
+##### holderAddress
+
+`string`
+
+The address to transfer the attestation to.
+
+##### identity?
+
+`string`
 
 The identity to perform the attestation operation with.
 
 #### Returns
 
-`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+`Promise`\<`void`\>
 
-The updated attestation details.
+Nothing.
 
 ***
 
 ### destroy()
 
-> **destroy**(`attestationId`, `identity`?): `Promise`\<`void`\>
+> **destroy**(`attestationId`, `identity?`): `Promise`\<`void`\>
 
 Destroy the attestation.
 
 #### Parameters
 
-• **attestationId**: `string`
+##### attestationId
+
+`string`
 
 The attestation to transfer.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the attestation operation with.
 
@@ -136,4 +134,4 @@ The identity to perform the attestation operation with.
 
 `Promise`\<`void`\>
 
-The updated attestation details.
+Nothing.

package/docs/reference/interfaces/IAttestationConnector.md

@@ -8,111 +8,99 @@ Interface describing an attestation connector.
 
 ## Methods
 
-### attest()
+### create()
 
-> **attest**\<`T`\>(`controller`, `address`, `verificationMethodId`, `data`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+> **create**(`controller`, `verificationMethodId`, `attestationObject`): `Promise`\<`string`\>
 
 Attest the data and return the collated information.
 
-#### Type Parameters
-
-• **T** = `unknown`
-
 #### Parameters
 
-• **controller**: `string`
+##### controller
 
-The controller identity of the user to access the vault keys.
+`string`
 
-• **address**: `string`
+The controller identity of the user to access the vault keys.
 
-The controller address for the attestation.
+##### verificationMethodId
 
-• **verificationMethodId**: `string`
+`string`
 
 The identity verification method to use for attesting the data.
 
-• **data**: `T`
+##### attestationObject
+
+`IJsonLdNodeObject`
 
 The data to attest.
 
 #### Returns
 
-`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+`Promise`\<`string`\>
 
 The collated attestation data.
 
 ***
 
-### verify()
+### get()
 
-> **verify**\<`T`\>(`attestationId`): `Promise`\<`object`\>
+> **get**(`id`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
 
 Resolve and verify the attestation id.
 
-#### Type Parameters
-
-• **T** = `unknown`
-
 #### Parameters
 
-• **attestationId**: `string`
+##### id
+
+`string`
 
 The attestation id to verify.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
 
 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**(`controller`, `attestationId`, `holderIdentity`, `holderAddress`): `Promise`\<`void`\>
 
 Transfer the attestation to a new holder.
 
-#### Type Parameters
-
-• **T** = `unknown`
-
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller identity of the user to access the vault keys.
 
-• **attestationId**: `string`
+##### attestationId
+
+`string`
 
 The attestation to transfer.
 
-• **holderIdentity**: `string`
+##### holderIdentity
+
+`string`
 
 The holder identity of the attestation.
 
-• **holderAddress**: `string`
+##### holderAddress
+
+`string`
 
 The new controller address of the attestation belonging to the holder.
 
 #### Returns
 
-`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+`Promise`\<`void`\>
 
-The updated attestation details.
+Nothing.
 
 ***
 
@@ -124,11 +112,15 @@ Destroy the attestation.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller identity of the user to access the vault keys.
 
-• **attestationId**: `string`
+##### attestationId
+
+`string`
 
 The attestation to destroy.
 

package/docs/reference/interfaces/{IAttestationAttestRequest.md → IAttestationCreateRequest.md}

@@ -1,6 +1,6 @@
-# Interface: IAttestationAttestRequest
+# Interface: IAttestationCreateRequest
 
-Attest the data and return the collated attestation details.
+Attest the data and return the id of the attestation.
 
 ## Properties
 
@@ -10,15 +10,9 @@ Attest the data and return the collated attestation details.
 
 The data to be used in the signing.
 
-#### verificationMethodId
+#### attestationObject
 
-> **verificationMethodId**: `string`
-
-The identity verification method to use for attesting the data.
-
-#### data
-
-> **data**: `unknown`
+> **attestationObject**: `IJsonLdNodeObject`
 
 The data object to attest.
 

package/docs/reference/interfaces/IAttestationGetRequest.md

@@ -0,0 +1,29 @@
+# Interface: IAttestationGetRequest
+
+Verify that the proof is valid for the attestation.
+
+## 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 to be used in the verification.
+
+#### id
+
+> **id**: `string`
+
+The attestation id to verify.

package/docs/reference/interfaces/IAttestationGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAttestationGetResponse
+
+The response to verifying the attestation.
+
+## 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**: [`IAttestationInformation`](IAttestationInformation.md)
+
+The data returned from the verification response.