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

package/dist/cjs/index.cjs

@@ -1,7 +1,185 @@
 'use strict';
 
+var dataCore = require('@twin.org/data-core');
 var core = require('@twin.org/core');
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of attestation data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AttestationTypes = {
+    /**
+     * The context root for the attestation types.
+     */
+    ContextRoot: "https://schema.twindev.org/attestation/",
+    /**
+     * Represents attestation information.
+     */
+    Information: "Information",
+    /**
+     * Represents attestation JWT proof.
+     */
+    JwtProof: "JwtProof"
+};
+
+var type$1 = "object";
+var properties$1 = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/attestation/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/attestation/"
+					}
+				],
+				additionalItems: {
+					type: "string"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "Information",
+		description: "JSON-LD Type."
+	},
+	id: {
+		type: "string",
+		description: "The unique identifier of the attestation."
+	},
+	dateCreated: {
+		type: "string",
+		description: "Created date/time of the attestation in ISO format."
+	},
+	dateTransferred: {
+		type: "string",
+		description: "Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner."
+	},
+	ownerIdentity: {
+		type: "string",
+		description: "The identity of the owner."
+	},
+	holderIdentity: {
+		type: "string",
+		description: "The identity of the current holder, can be undefined if owner is still the holder."
+	},
+	attestationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The data that was attested."
+	},
+	proof: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The proof for the attested data."
+	},
+	verified: {
+		type: "boolean",
+		description: "Whether the attestation has been verified."
+	},
+	verificationFailure: {
+		type: "string",
+		description: "The verification failure message."
+	}
+};
+var required$1 = [
+	"@context",
+	"type",
+	"id",
+	"dateCreated",
+	"ownerIdentity",
+	"attestationObject"
+];
+var additionalProperties$1 = false;
+var description$1 = "Interface describing the collated attestation information.";
+var AttestationInformationSchema = {
+	type: type$1,
+	properties: properties$1,
+	required: required$1,
+	additionalProperties: additionalProperties$1,
+	description: description$1
+};
+
+var type = "object";
+var properties = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/attestation/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/attestation/"
+					}
+				],
+				additionalItems: {
+					type: "string"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "JwtProof",
+		description: "The type of the proof."
+	},
+	value: {
+		type: "string",
+		description: "The value of the proof."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"value"
+];
+var additionalProperties = false;
+var description = "Interface describing an attestation proof.";
+var AttestationJwtProofSchema = {
+	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 attestation.
+ */
+class AttestationDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes() {
+        dataCore.DataTypeHandlerFactory.register(AttestationTypes.Information, () => ({
+            type: AttestationTypes.Information,
+            defaultValue: {},
+            jsonSchema: async () => AttestationInformationSchema
+        }));
+        dataCore.DataTypeHandlerFactory.register(AttestationTypes.JwtProof, () => ({
+            type: AttestationTypes.JwtProof,
+            defaultValue: {},
+            jsonSchema: async () => AttestationJwtProofSchema
+        }));
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -11,3 +189,5 @@ var core = require('@twin.org/core');
 const AttestationConnectorFactory = core.Factory.createFactory("attestation");
 
 exports.AttestationConnectorFactory = AttestationConnectorFactory;
+exports.AttestationDataTypes = AttestationDataTypes;
+exports.AttestationTypes = AttestationTypes;

package/dist/esm/index.mjs

@@ -1,5 +1,183 @@
+import { DataTypeHandlerFactory } from '@twin.org/data-core';
 import { Factory } from '@twin.org/core';
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of attestation data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AttestationTypes = {
+    /**
+     * The context root for the attestation types.
+     */
+    ContextRoot: "https://schema.twindev.org/attestation/",
+    /**
+     * Represents attestation information.
+     */
+    Information: "Information",
+    /**
+     * Represents attestation JWT proof.
+     */
+    JwtProof: "JwtProof"
+};
+
+var type$1 = "object";
+var properties$1 = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/attestation/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/attestation/"
+					}
+				],
+				additionalItems: {
+					type: "string"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "Information",
+		description: "JSON-LD Type."
+	},
+	id: {
+		type: "string",
+		description: "The unique identifier of the attestation."
+	},
+	dateCreated: {
+		type: "string",
+		description: "Created date/time of the attestation in ISO format."
+	},
+	dateTransferred: {
+		type: "string",
+		description: "Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner."
+	},
+	ownerIdentity: {
+		type: "string",
+		description: "The identity of the owner."
+	},
+	holderIdentity: {
+		type: "string",
+		description: "The identity of the current holder, can be undefined if owner is still the holder."
+	},
+	attestationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The data that was attested."
+	},
+	proof: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "The proof for the attested data."
+	},
+	verified: {
+		type: "boolean",
+		description: "Whether the attestation has been verified."
+	},
+	verificationFailure: {
+		type: "string",
+		description: "The verification failure message."
+	}
+};
+var required$1 = [
+	"@context",
+	"type",
+	"id",
+	"dateCreated",
+	"ownerIdentity",
+	"attestationObject"
+];
+var additionalProperties$1 = false;
+var description$1 = "Interface describing the collated attestation information.";
+var AttestationInformationSchema = {
+	type: type$1,
+	properties: properties$1,
+	required: required$1,
+	additionalProperties: additionalProperties$1,
+	description: description$1
+};
+
+var type = "object";
+var properties = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/attestation/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/attestation/"
+					}
+				],
+				additionalItems: {
+					type: "string"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	type: {
+		type: "string",
+		"const": "JwtProof",
+		description: "The type of the proof."
+	},
+	value: {
+		type: "string",
+		description: "The value of the proof."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"value"
+];
+var additionalProperties = false;
+var description = "Interface describing an attestation proof.";
+var AttestationJwtProofSchema = {
+	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 attestation.
+ */
+class AttestationDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes() {
+        DataTypeHandlerFactory.register(AttestationTypes.Information, () => ({
+            type: AttestationTypes.Information,
+            defaultValue: {},
+            jsonSchema: async () => AttestationInformationSchema
+        }));
+        DataTypeHandlerFactory.register(AttestationTypes.JwtProof, () => ({
+            type: AttestationTypes.JwtProof,
+            defaultValue: {},
+            jsonSchema: async () => AttestationJwtProofSchema
+        }));
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -8,4 +186,4 @@ import { Factory } from '@twin.org/core';
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const AttestationConnectorFactory = Factory.createFactory("attestation");
 
-export { AttestationConnectorFactory };
+export { AttestationConnectorFactory, AttestationDataTypes, AttestationTypes };

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

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

package/dist/types/index.d.ts

@@ -1,12 +1,12 @@
+export * from "./dataTypes/attestationDataTypes";
 export * from "./factories/attestationConnectorFactory";
+export * from "./models/api/IAttestationCreateRequest";
+export * from "./models/api/IAttestationDestroyRequest";
+export * from "./models/api/IAttestationGetRequest";
+export * from "./models/api/IAttestationGetResponse";
+export * from "./models/api/IAttestationTransferRequest";
+export * from "./models/attestationTypes";
 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";
+export * from "./models/IAttestationJwtProof";

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

@@ -8,36 +8,32 @@ 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 attestationObject 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.
+     * @returns The id of the attestation.
      */
-    attest<T extends IJsonLdNodeObject = IJsonLdNodeObject>(verificationMethodId: string, data: T, namespace?: string, identity?: string, nodeIdentity?: string): Promise<IAttestationInformation<T>>;
+    create(verificationMethodId: string, attestationObject: IJsonLdNodeObject, namespace?: string, identity?: string, nodeIdentity?: string): Promise<string>;
     /**
      * Resolve and verify the attestation id.
-     * @param attestationId The attestation id to verify.
+     * @param id The attestation id to verify.
      * @returns The verified attestation details.
      */
-    verify<T extends IJsonLdNodeObject = IJsonLdNodeObject>(attestationId: string): Promise<{
-        verified: boolean;
-        failure?: string;
-        information?: Partial<IAttestationInformation<T>>;
-    }>;
+    get(id: string): Promise<IAttestationInformation>;
     /**
      * 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.
+     * @returns Nothing.
      */
-    transfer<T extends IJsonLdNodeObject = IJsonLdNodeObject>(attestationId: string, holderIdentity: string, identity?: string): Promise<IAttestationInformation<T>>;
+    transfer(attestationId: string, holderIdentity: string, identity?: string): Promise<void>;
     /**
      * Destroy the attestation.
      * @param attestationId The attestation to transfer.
      * @param identity The identity to perform the attestation operation with.
-     * @returns The updated attestation details.
+     * @returns Nothing.
      */
     destroy(attestationId: string, identity?: string): Promise<void>;
 }

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

@@ -10,29 +10,25 @@ export interface IAttestationConnector extends IComponent {
      * @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.
+     * @param attestationObject The data to attest.
      * @returns The collated attestation data.
      */
-    attest<T extends IJsonLdNodeObject = IJsonLdNodeObject>(controller: string, address: string, verificationMethodId: string, data: T): Promise<IAttestationInformation<T>>;
+    create(controller: string, address: string, verificationMethodId: string, attestationObject: IJsonLdNodeObject): Promise<string>;
     /**
      * Resolve and verify the attestation id.
-     * @param attestationId The attestation id to verify.
+     * @param id The attestation id to verify.
      * @returns The verified attestation details.
      */
-    verify<T extends IJsonLdNodeObject = IJsonLdNodeObject>(attestationId: string): Promise<{
-        verified: boolean;
-        failure?: string;
-        information?: Partial<IAttestationInformation<T>>;
-    }>;
+    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 The updated attestation details.
+     * @returns Nothing.
      */
-    transfer<T extends IJsonLdNodeObject = IJsonLdNodeObject>(controller: string, attestationId: string, holderIdentity: string, holderAddress: string): Promise<IAttestationInformation<T>>;
+    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.

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

@@ -1,9 +1,17 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IAttestationProof } from "./IAttestationProof";
+import type { AttestationTypes } from "./attestationTypes";
 /**
  * Interface describing the collated attestation information.
  */
-export interface IAttestationInformation<T extends IJsonLdNodeObject = IJsonLdNodeObject> {
+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.
      */
@@ -11,15 +19,15 @@ export interface IAttestationInformation<T extends IJsonLdNodeObject = IJsonLdNo
     /**
      * Created date/time of the attestation in ISO format.
      */
-    created: string;
+    dateCreated: string;
     /**
-     * The identity of the owner.
+     * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
      */
-    ownerIdentity: string;
+    dateTransferred?: string;
     /**
-     * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
+     * The identity of the owner.
      */
-    transferred?: string;
+    ownerIdentity: string;
     /**
      * The identity of the current holder, can be undefined if owner is still the holder.
      */
@@ -27,9 +35,17 @@ export interface IAttestationInformation<T extends IJsonLdNodeObject = IJsonLdNo
     /**
      * The data that was attested.
      */
-    data: T;
+    attestationObject: IJsonLdNodeObject;
     /**
      * The proof for the attested data.
      */
-    proof: IAttestationProof;
+    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/{IAttestationAttestRequest.d.ts → IAttestationCreateRequest.d.ts}

@@ -1,8 +1,8 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 /**
- * Attest the data and return the collated attestation details.
+ * Attest the data and return the id of the attestation.
  */
-export interface IAttestationAttestRequest {
+export interface IAttestationCreateRequest {
     /**
      * The data to be used in the signing.
      */
@@ -14,7 +14,7 @@ export interface IAttestationAttestRequest {
         /**
          * The data object to attest.
          */
-        data: IJsonLdNodeObject;
+        attestationObject: IJsonLdNodeObject;
         /**
          * The namespace of the connector to use for the attestation, defaults to component configured namespace.
          */

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

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