@twin.org/attestation-models 0.0.1-next.7 → 0.0.1-next.8

package/docs/reference/classes/AttestationDataTypes.md

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

package/docs/reference/index.md

@@ -1,19 +1,26 @@
 # @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
+
+- [AttestationTypes](type-aliases/AttestationTypes.md)
 
 ## Variables
 
 - [AttestationConnectorFactory](variables/AttestationConnectorFactory.md)
+- [AttestationTypes](variables/AttestationTypes.md)

package/docs/reference/interfaces/IAttestationComponent.md

@@ -8,23 +8,19 @@ Interface describing an attestation contract.
 
 ## Methods
 
-### attest()
+### create()
 
-> **attest**\<`T`\>(`verificationMethodId`, `data`, `namespace`?, `identity`?, `nodeIdentity`?): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+> **create**(`verificationMethodId`, `attestationObject`, `namespace`?, `identity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 Attest the data and return the collated information.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdNodeObject`
-
 #### Parameters
 
 • **verificationMethodId**: `string`
 
 The identity verification method to use for attesting the data.
 
-• **data**: `T`
+• **attestationObject**: `IJsonLdNodeObject`
 
 The data to attest.
 
@@ -42,58 +38,38 @@ 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** *extends* `IJsonLdNodeObject`
-
 #### 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`, `identity`?): `Promise`\<`void`\>
 
 Transfer the attestation to a new holder.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdNodeObject`
-
 #### Parameters
 
 • **attestationId**: `string`
@@ -110,9 +86,9 @@ The identity to perform the attestation operation with.
 
 #### Returns
 
-`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+`Promise`\<`void`\>
 
-The updated attestation details.
+Nothing.
 
 ***
 
@@ -136,4 +112,4 @@ The identity to perform the attestation operation with.
 
 `Promise`\<`void`\>
 
-The updated attestation details.
+Nothing.

package/docs/reference/interfaces/IAttestationConnector.md

@@ -8,16 +8,12 @@ Interface describing an attestation connector.
 
 ## Methods
 
-### attest()
+### create()
 
-> **attest**\<`T`\>(`controller`, `address`, `verificationMethodId`, `data`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+> **create**(`controller`, `address`, `verificationMethodId`, `attestationObject`): `Promise`\<`string`\>
 
 Attest the data and return the collated information.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdNodeObject`
-
 #### Parameters
 
 • **controller**: `string`
@@ -32,64 +28,44 @@ The controller address for the attestation.
 
 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** *extends* `IJsonLdNodeObject`
-
 #### 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** *extends* `IJsonLdNodeObject`
-
 #### Parameters
 
 • **controller**: `string`
@@ -110,9 +86,9 @@ The new controller address of the attestation belonging to the holder.
 
 #### Returns
 
-`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\<`T`\>\>
+`Promise`\<`void`\>
 
-The updated attestation details.
+Nothing.
 
 ***
 

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
 
@@ -16,9 +16,9 @@ The data to be used in the signing.
 
 The identity verification method to use for attesting the data.
 
-#### data
+#### attestationObject
 
-> **data**: `IJsonLdNodeObject`
+> **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.

package/docs/reference/interfaces/IAttestationInformation.md

@@ -1,12 +1,24 @@
-# Interface: IAttestationInformation\<T\>
+# Interface: IAttestationInformation
 
 Interface describing the collated attestation information.
 
-## Type Parameters
+## Properties
 
-• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
+### @context
 
-## Properties
+> **@context**: `"https://schema.twindev.org/attestation/"` \| [`"https://schema.twindev.org/attestation/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"Information"`
+
+JSON-LD Type.
+
+***
 
 ### id
 
@@ -16,27 +28,27 @@ The unique identifier of the attestation.
 
 ***
 
-### created
+### dateCreated
 
-> **created**: `string`
+> **dateCreated**: `string`
 
 Created date/time of the attestation in ISO format.
 
 ***
 
-### ownerIdentity
+### dateTransferred?
 
-> **ownerIdentity**: `string`
+> `optional` **dateTransferred**: `string`
 
-The identity of the owner.
+Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
 
 ***
 
-### transferred?
+### ownerIdentity
 
-> `optional` **transferred**: `string`
+> **ownerIdentity**: `string`
 
-Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
+The identity of the owner.
 
 ***
 
@@ -48,16 +60,32 @@ The identity of the current holder, can be undefined if owner is still the holde
 
 ***
 
-### data
+### attestationObject
 
-> **data**: `T`
+> **attestationObject**: `IJsonLdNodeObject`
 
 The data that was attested.
 
 ***
 
-### proof
+### proof?
 
-> **proof**: [`IAttestationProof`](IAttestationProof.md)
+> `optional` **proof**: `IJsonLdNodeObject`
 
 The proof for the attested data.
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+Whether the attestation has been verified.
+
+***
+
+### verificationFailure?
+
+> `optional` **verificationFailure**: `string`
+
+The verification failure message.

package/docs/reference/interfaces/IAttestationJwtProof.md

@@ -0,0 +1,27 @@
+# Interface: IAttestationJwtProof
+
+Interface describing an attestation proof.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/attestation/"` \| [`"https://schema.twindev.org/attestation/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"JwtProof"`
+
+The type of the proof.
+
+***
+
+### value
+
+> **value**: `string`
+
+The value of the proof.

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

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

package/docs/reference/variables/AttestationTypes.md

@@ -0,0 +1,25 @@
+# Variable: AttestationTypes
+
+> `const` **AttestationTypes**: `object`
+
+The types of attestation data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/attestation/"` = `"https://schema.twindev.org/attestation/"`
+
+The context root for the attestation types.
+
+### Information
+
+> `readonly` **Information**: `"Information"` = `"Information"`
+
+Represents attestation information.
+
+### JwtProof
+
+> `readonly` **JwtProof**: `"JwtProof"` = `"JwtProof"`
+
+Represents attestation JWT proof.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/attestation-models",
-	"version": "0.0.1-next.7",
+	"version": "0.0.1-next.8",
 	"description": "Models which define the structure of the attestation connectors and services",
 	"repository": {
 		"type": "git",
@@ -15,10 +15,12 @@
 	},
 	"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/standards-w3c-did": "next",
+		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",

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

@@ -1,13 +0,0 @@
-/**
- * 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/IAttestationAttestResponse.d.ts

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

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

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

@@ -1,14 +0,0 @@
-/**
- * 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

@@ -1,23 +0,0 @@
-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/reference/interfaces/IAttestationAttestResponse.md

@@ -1,17 +0,0 @@
-# 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)\<`IJsonLdNodeObject`\>
-
-The attestation information.

package/docs/reference/interfaces/IAttestationProof.md

@@ -1,19 +0,0 @@
-# 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/IAttestationTransferResponse.md

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