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

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

@@ -0,0 +1,39 @@
+import type { IComponent } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+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 attestationObject The data to attest.
+     * @returns The collated attestation data.
+     */
+    create(controller: string, address: string, verificationMethodId: string, attestationObject: IJsonLdNodeObject): Promise<string>;
+    /**
+     * Resolve and verify the attestation id.
+     * @param id The attestation id to verify.
+     * @returns The verified attestation details.
+     */
+    get(id: string): Promise<IAttestationInformation>;
+    /**
+     * 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 Nothing.
+     */
+    transfer(controller: string, attestationId: string, holderIdentity: string, holderAddress: string): Promise<void>;
+    /**
+     * 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,51 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { AttestationTypes } from "./attestationTypes";
+/**
+ * Interface describing the collated attestation information.
+ */
+export interface IAttestationInformation {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof AttestationTypes.ContextRoot | [typeof AttestationTypes.ContextRoot, ...string[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AttestationTypes.Information;
+    /**
+     * The unique identifier of the attestation.
+     */
+    id: string;
+    /**
+     * Created date/time of the attestation in ISO format.
+     */
+    dateCreated: string;
+    /**
+     * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
+     */
+    dateTransferred?: string;
+    /**
+     * The identity of the owner.
+     */
+    ownerIdentity: string;
+    /**
+     * The identity of the current holder, can be undefined if owner is still the holder.
+     */
+    holderIdentity?: string;
+    /**
+     * The data that was attested.
+     */
+    attestationObject: IJsonLdNodeObject;
+    /**
+     * The proof for the attested data.
+     */
+    proof?: IJsonLdNodeObject;
+    /**
+     * Whether the attestation has been verified.
+     */
+    verified?: boolean;
+    /**
+     * The verification failure message.
+     */
+    verificationFailure?: string;
+}

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

@@ -0,0 +1,18 @@
+import type { AttestationTypes } from "./attestationTypes";
+/**
+ * Interface describing an attestation proof.
+ */
+export interface IAttestationJwtProof {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof AttestationTypes.ContextRoot | [typeof AttestationTypes.ContextRoot, ...string[]];
+    /**
+     * The type of the proof.
+     */
+    type: typeof AttestationTypes.JwtProof;
+    /**
+     * The value of the proof.
+     */
+    value: string;
+}

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

@@ -0,0 +1,23 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Attest the data and return the id of the attestation.
+ */
+export interface IAttestationCreateRequest {
+    /**
+     * 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.
+         */
+        attestationObject: IJsonLdNodeObject;
+        /**
+         * The namespace of the connector to use for the attestation, defaults to component configured namespace.
+         */
+        namespace?: string;
+    };
+}

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

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

@@ -0,0 +1,21 @@
+/**
+ * The types of attestation data.
+ */
+export declare const AttestationTypes: {
+    /**
+     * The context root for the attestation types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/attestation/";
+    /**
+     * 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

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

package/docs/examples.md

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

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

@@ -0,0 +1,26 @@
+# @twin.org/attestation-models
+
+## Classes
+
+- [AttestationDataTypes](classes/AttestationDataTypes.md)
+
+## Interfaces
+
+- [IAttestationComponent](interfaces/IAttestationComponent.md)
+- [IAttestationConnector](interfaces/IAttestationConnector.md)
+- [IAttestationInformation](interfaces/IAttestationInformation.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)
+
+## Type Aliases
+
+- [AttestationTypes](type-aliases/AttestationTypes.md)
+
+## Variables
+
+- [AttestationConnectorFactory](variables/AttestationConnectorFactory.md)
+- [AttestationTypes](variables/AttestationTypes.md)

package/docs/reference/interfaces/IAttestationComponent.md

@@ -0,0 +1,115 @@
+# Interface: IAttestationComponent
+
+Interface describing an attestation contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create()
+
+> **create**(`verificationMethodId`, `attestationObject`, `namespace`?, `identity`?, `nodeIdentity`?): `Promise`\<`string`\>
+
+Attest the data and return the collated information.
+
+#### Parameters
+
+• **verificationMethodId**: `string`
+
+The identity verification method to use for attesting the data.
+
+• **attestationObject**: `IJsonLdNodeObject`
+
+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`\<`string`\>
+
+The id of the attestation.
+
+***
+
+### get()
+
+> **get**(`id`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
+
+Resolve and verify the attestation id.
+
+#### Parameters
+
+• **id**: `string`
+
+The attestation id to verify.
+
+#### Returns
+
+`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
+
+The verified attestation details.
+
+***
+
+### transfer()
+
+> **transfer**(`attestationId`, `holderIdentity`, `identity`?): `Promise`\<`void`\>
+
+Transfer the attestation to a new holder.
+
+#### 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`\<`void`\>
+
+Nothing.
+
+***
+
+### 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`\>
+
+Nothing.

package/docs/reference/interfaces/IAttestationConnector.md

@@ -0,0 +1,115 @@
+# Interface: IAttestationConnector
+
+Interface describing an attestation connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create()
+
+> **create**(`controller`, `address`, `verificationMethodId`, `attestationObject`): `Promise`\<`string`\>
+
+Attest the data and return the collated information.
+
+#### 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.
+
+• **attestationObject**: `IJsonLdNodeObject`
+
+The data to attest.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The collated attestation data.
+
+***
+
+### get()
+
+> **get**(`id`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
+
+Resolve and verify the attestation id.
+
+#### Parameters
+
+• **id**: `string`
+
+The attestation id to verify.
+
+#### Returns
+
+`Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
+
+The verified attestation details.
+
+***
+
+### transfer()
+
+> **transfer**(`controller`, `attestationId`, `holderIdentity`, `holderAddress`): `Promise`\<`void`\>
+
+Transfer the attestation to a new holder.
+
+#### 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`\<`void`\>
+
+Nothing.
+
+***
+
+### 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/IAttestationCreateRequest.md

@@ -0,0 +1,29 @@
+# Interface: IAttestationCreateRequest
+
+Attest the data and return the id of the attestation.
+
+## 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.
+
+#### attestationObject
+
+> **attestationObject**: `IJsonLdNodeObject`
+
+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/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/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.