@twin.org/attestation-models 0.0.2-next.4 → 0.0.3-next.10

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Attestation Models
 
-Models which define the structure of the attestation contracts and connectors.
+Shared models and data types for attestation connectors and services.
 
 ## Installation
 

package/dist/es/dataTypes/attestationDataTypes.js

@@ -0,0 +1,30 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { DataTypeHandlerFactory } from "@twin.org/data-core";
+import { AttestationContexts } from "../models/attestationContexts.js";
+import { AttestationTypes } from "../models/attestationTypes.js";
+import AttestationInformationSchema from "../schemas/AttestationInformation.json" with { type: "json" };
+import AttestationJwtProofSchema from "../schemas/AttestationJwtProof.json" with { type: "json" };
+/**
+ * Handle all the data types for attestation.
+ */
+export class AttestationDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes() {
+        DataTypeHandlerFactory.register(`${AttestationContexts.Namespace}${AttestationTypes.Information}`, () => ({
+            namespace: AttestationContexts.Namespace,
+            type: AttestationTypes.Information,
+            defaultValue: {},
+            jsonSchema: async () => AttestationInformationSchema
+        }));
+        DataTypeHandlerFactory.register(`${AttestationContexts.Namespace}${AttestationTypes.JwtProof}`, () => ({
+            namespace: AttestationContexts.Namespace,
+            type: AttestationTypes.JwtProof,
+            defaultValue: {},
+            jsonSchema: async () => AttestationJwtProofSchema
+        }));
+    }
+}
+//# sourceMappingURL=attestationDataTypes.js.map

package/dist/es/dataTypes/attestationDataTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attestationDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/attestationDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,4BAA4B,MAAM,wCAAwC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACxG,OAAO,yBAAyB,MAAM,qCAAqC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAElG;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,mBAAmB,CAAC,SAAS,GAAG,gBAAgB,CAAC,WAAW,EAAE,EACjE,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,mBAAmB,CAAC,SAAS;YACxC,IAAI,EAAE,gBAAgB,CAAC,WAAW;YAClC,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,4BAA4B;SACpD,CAAC,CACF,CAAC;QACF,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,mBAAmB,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,EAAE,EAC9D,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,mBAAmB,CAAC,SAAS;YACxC,IAAI,EAAE,gBAAgB,CAAC,QAAQ;YAC/B,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,yBAAyB;SACjD,CAAC,CACF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHandlerFactory } from \"@twin.org/data-core\";\nimport { AttestationContexts } from \"../models/attestationContexts.js\";\nimport { AttestationTypes } from \"../models/attestationTypes.js\";\nimport AttestationInformationSchema from \"../schemas/AttestationInformation.json\" with { type: \"json\" };\nimport AttestationJwtProofSchema from \"../schemas/AttestationJwtProof.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for attestation.\n */\nexport class AttestationDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${AttestationContexts.Namespace}${AttestationTypes.Information}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: AttestationContexts.Namespace,\n\t\t\t\ttype: AttestationTypes.Information,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => AttestationInformationSchema\n\t\t\t})\n\t\t);\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${AttestationContexts.Namespace}${AttestationTypes.JwtProof}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: AttestationContexts.Namespace,\n\t\t\t\ttype: AttestationTypes.JwtProof,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => AttestationJwtProofSchema\n\t\t\t})\n\t\t);\n\t}\n}\n"]}

package/dist/es/factories/attestationConnectorFactory.js

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

package/dist/es/factories/attestationConnectorFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attestationConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/attestationConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GACvC,OAAO,CAAC,aAAa,CAAwB,aAAa,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IAttestationConnector } from \"../models/IAttestationConnector.js\";\n\n/**\n * Factory for creating attestation connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AttestationConnectorFactory =\n\tFactory.createFactory<IAttestationConnector>(\"attestation\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,16 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./dataTypes/attestationDataTypes.js";
+export * from "./factories/attestationConnectorFactory.js";
+export * from "./models/api/IAttestationCreateRequest.js";
+export * from "./models/api/IAttestationDestroyRequest.js";
+export * from "./models/api/IAttestationGetRequest.js";
+export * from "./models/api/IAttestationGetResponse.js";
+export * from "./models/api/IAttestationTransferRequest.js";
+export * from "./models/attestationContexts.js";
+export * from "./models/attestationTypes.js";
+export * from "./models/IAttestationComponent.js";
+export * from "./models/IAttestationConnector.js";
+export * from "./models/IAttestationInformation.js";
+export * from "./models/IAttestationJwtProof.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mCAAmC,CAAC;AAClD,cAAc,mCAAmC,CAAC;AAClD,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/attestationDataTypes.js\";\nexport * from \"./factories/attestationConnectorFactory.js\";\nexport * from \"./models/api/IAttestationCreateRequest.js\";\nexport * from \"./models/api/IAttestationDestroyRequest.js\";\nexport * from \"./models/api/IAttestationGetRequest.js\";\nexport * from \"./models/api/IAttestationGetResponse.js\";\nexport * from \"./models/api/IAttestationTransferRequest.js\";\nexport * from \"./models/attestationContexts.js\";\nexport * from \"./models/attestationTypes.js\";\nexport * from \"./models/IAttestationComponent.js\";\nexport * from \"./models/IAttestationConnector.js\";\nexport * from \"./models/IAttestationInformation.js\";\nexport * from \"./models/IAttestationJwtProof.js\";\n"]}

package/dist/es/models/IAttestationComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAttestationComponent.js.map

package/dist/es/models/IAttestationComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationComponent.js","sourceRoot":"","sources":["../../../src/models/IAttestationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IAttestationInformation } from \"./IAttestationInformation.js\";\n\n/**\n * Interface describing an attestation contract.\n */\nexport interface IAttestationComponent extends IComponent {\n\t/**\n\t * Attest the data and return the collated information.\n\t * @param attestationObject The data to attest.\n\t * @param namespace The namespace of the connector to use for the attestation, defaults to component configured namespace.\n\t * @returns The id of the attestation.\n\t */\n\tcreate(attestationObject: IJsonLdNodeObject, namespace?: string): Promise<string>;\n\n\t/**\n\t * Resolve and verify the attestation id.\n\t * @param id The attestation id to verify.\n\t * @returns The verified attestation details.\n\t */\n\tget(id: string): Promise<IAttestationInformation>;\n\n\t/**\n\t * Transfer the attestation to a new holder.\n\t * @param attestationId The attestation to transfer.\n\t * @param holderIdentity The identity to transfer the attestation to.\n\t * @param holderAddress The address to transfer the attestation to.\n\t * @returns Nothing.\n\t */\n\ttransfer(attestationId: string, holderIdentity: string, holderAddress: string): Promise<void>;\n\n\t/**\n\t * Destroy the attestation.\n\t * @param attestationId The attestation to transfer.\n\t * @returns Nothing.\n\t */\n\tdestroy(attestationId: string): Promise<void>;\n}\n"]}

package/dist/es/models/IAttestationConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAttestationConnector.js.map

package/dist/es/models/IAttestationConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationConnector.js","sourceRoot":"","sources":["../../../src/models/IAttestationConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IAttestationInformation } from \"./IAttestationInformation.js\";\n\n/**\n * Interface describing an attestation connector.\n */\nexport interface IAttestationConnector extends IComponent {\n\t/**\n\t * Attest the data and return the collated information.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param verificationMethodId The identity verification method to use for attesting the data.\n\t * @param attestationObject The data to attest.\n\t * @returns The collated attestation data.\n\t */\n\tcreate(\n\t\tcontroller: string,\n\t\tverificationMethodId: string,\n\t\tattestationObject: IJsonLdNodeObject\n\t): Promise<string>;\n\n\t/**\n\t * Resolve and verify the attestation id.\n\t * @param id The attestation id to verify.\n\t * @returns The verified attestation details.\n\t */\n\tget(id: string): Promise<IAttestationInformation>;\n\n\t/**\n\t * Transfer the attestation to a new holder.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param attestationId The attestation to transfer.\n\t * @param holderIdentity The holder identity of the attestation.\n\t * @param holderAddress The new controller address of the attestation belonging to the holder.\n\t * @returns Nothing.\n\t */\n\ttransfer(\n\t\tcontroller: string,\n\t\tattestationId: string,\n\t\tholderIdentity: string,\n\t\tholderAddress: string\n\t): Promise<void>;\n\n\t/**\n\t * Destroy the attestation.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param attestationId The attestation to destroy.\n\t * @returns Nothing.\n\t */\n\tdestroy(controller: string, attestationId: string): Promise<void>;\n}\n"]}

package/dist/es/models/IAttestationInformation.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAttestationInformation.js.map

package/dist/es/models/IAttestationInformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationInformation.js","sourceRoot":"","sources":["../../../src/models/IAttestationInformation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts } from \"@twin.org/standards-schema-org\";\nimport type { AttestationContexts } from \"./attestationContexts.js\";\nimport type { AttestationTypes } from \"./attestationTypes.js\";\n\n/**\n * Interface describing the collated attestation information.\n */\nexport interface IAttestationInformation {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.Context,\n\t\ttypeof AttestationContexts.Context,\n\t\ttypeof AttestationContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof AttestationTypes.Information;\n\n\t/**\n\t * The unique identifier of the attestation.\n\t */\n\tid: string;\n\n\t/**\n\t * Created date/time of the attestation in ISO format.\n\t * @json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.\n\t * @json-ld type:schema:Date\n\t */\n\tdateTransferred?: string;\n\n\t/**\n\t * The identity of the owner.\n\t * @json-ld type:schema:identifier\n\t */\n\townerIdentity: string;\n\n\t/**\n\t * The identity of the current holder, can be undefined if owner is still the holder.\n\t * @json-ld type:schema:identifier\n\t */\n\tholderIdentity?: string;\n\n\t/**\n\t * The data that was attested.\n\t * @json-ld namespace:twin-common\n\t */\n\tattestationObject: IJsonLdNodeObject;\n\n\t/**\n\t * The proof for the attested data.\n\t * @json-ld namespace:twin-attestation\n\t */\n\tproof?: IJsonLdNodeObject;\n\n\t/**\n\t * Whether the attestation has been verified.\n\t * @json-ld namespace:twin-common\n\t */\n\tverified?: boolean;\n\n\t/**\n\t * The verification failure message.\n\t * @json-ld type:schema:Text\n\t */\n\tverificationFailure?: string;\n}\n"]}

package/dist/es/models/IAttestationJwtProof.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAttestationJwtProof.js.map

package/dist/es/models/IAttestationJwtProof.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationJwtProof.js","sourceRoot":"","sources":["../../../src/models/IAttestationJwtProof.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { AttestationContexts } from \"./attestationContexts.js\";\nimport type { AttestationTypes } from \"./attestationTypes.js\";\n\n/**\n * Interface describing an attestation proof.\n */\nexport interface IAttestationJwtProof {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\":\n\t\t| typeof AttestationContexts.Context\n\t\t| [typeof AttestationContexts.Context, ...IJsonLdContextDefinitionElement[]];\n\n\t/**\n\t * The type of the proof.\n\t */\n\ttype: typeof AttestationTypes.JwtProof;\n\n\t/**\n\t * The value of the proof.\n\t * @json-ld type:schema:Text\n\t */\n\tvalue: string;\n}\n"]}

package/dist/es/models/api/IAttestationCreateRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAttestationCreateRequest.js.map

package/dist/es/models/api/IAttestationCreateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAttestationCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Attest the data and return the id of the attestation.\n */\nexport interface IAttestationCreateRequest {\n\t/**\n\t * The data to be used in the signing.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The data object to attest.\n\t\t */\n\t\tattestationObject: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The namespace of the connector to use for the attestation, defaults to component configured namespace.\n\t\t */\n\t\tnamespace?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAttestationDestroyRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IAttestationDestroyRequest.js.map

package/dist/es/models/api/IAttestationDestroyRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationDestroyRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAttestationDestroyRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Destroy the attestation.\n */\nexport interface IAttestationDestroyRequest {\n\t/**\n\t * The parameters to be used in the destruction.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The attestation id to destroy.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAttestationGetRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAttestationGetRequest.js.map

package/dist/es/models/api/IAttestationGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAttestationGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Verify that the proof is valid for the attestation.\n */\nexport interface IAttestationGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The parameters to be used in the verification.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The attestation id to verify.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAttestationGetResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAttestationGetResponse.js.map

package/dist/es/models/api/IAttestationGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IAttestationGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IAttestationInformation } from \"../IAttestationInformation.js\";\n\n/**\n * The response to verifying the attestation.\n */\nexport interface IAttestationGetResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The data returned from the verification response.\n\t */\n\tbody: IAttestationInformation;\n}\n"]}

package/dist/es/models/api/IAttestationTransferRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IAttestationTransferRequest.js.map

package/dist/es/models/api/IAttestationTransferRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAttestationTransferRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAttestationTransferRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Transfer the attestation to a new holder.\n */\nexport interface IAttestationTransferRequest {\n\t/**\n\t * The parameters to be used in the transfer.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The attestation id to transfer.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The parameters to be used in the transfer.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The new holder identity.\n\t\t */\n\t\tholderIdentity: string;\n\n\t\t/**\n\t\t * The new holder address.\n\t\t */\n\t\tholderAddress: string;\n\t};\n}\n"]}

package/dist/es/models/attestationContexts.js

@@ -0,0 +1,33 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of attestation data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const AttestationContexts = {
+    /**
+     * The canonical RDF namespace URI for Attestation.
+     */
+    Namespace: "https://schema.twindev.org/attestation/",
+    /**
+     * The value to use in context for Attestation.
+     */
+    Context: "https://schema.twindev.org/attestation/",
+    /**
+     * The JSON-LD Context URL for Attestation.
+     */
+    JsonLdContext: "https://schema.twindev.org/attestation/types.jsonld",
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    NamespaceCommon: "https://schema.twindev.org/common/",
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    ContextCommon: "https://schema.twindev.org/common/",
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld"
+};
+//# sourceMappingURL=attestationContexts.js.map

package/dist/es/models/attestationContexts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attestationContexts.js","sourceRoot":"","sources":["../../../src/models/attestationContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,yCAAyC;IAEpD;;OAEG;IACH,OAAO,EAAE,yCAAyC;IAElD;;OAEG;IACH,aAAa,EAAE,qDAAqD;IAEpE;;OAEG;IACH,eAAe,EAAE,oCAAoC;IAErD;;OAEG;IACH,aAAa,EAAE,oCAAoC;IAEnD;;OAEG;IACH,mBAAmB,EAAE,gDAAgD;CAC5D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of attestation data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AttestationContexts = {\n\t/**\n\t * The canonical RDF namespace URI for Attestation.\n\t */\n\tNamespace: \"https://schema.twindev.org/attestation/\",\n\n\t/**\n\t * The value to use in context for Attestation.\n\t */\n\tContext: \"https://schema.twindev.org/attestation/\",\n\n\t/**\n\t * The JSON-LD Context URL for Attestation.\n\t */\n\tJsonLdContext: \"https://schema.twindev.org/attestation/types.jsonld\",\n\n\t/**\n\t * The canonical RDF namespace URI for TWIN Common.\n\t */\n\tNamespaceCommon: \"https://schema.twindev.org/common/\",\n\n\t/**\n\t * The value to use in JSON-LD context for TWIN Common.\n\t */\n\tContextCommon: \"https://schema.twindev.org/common/\",\n\n\t/**\n\t * The JSON-LD Context URL for TWIN Common.\n\t */\n\tJsonLdContextCommon: \"https://schema.twindev.org/common/types.jsonld\"\n} as const;\n\n/**\n * The contexts of attestation data.\n */\nexport type AttestationContexts = (typeof AttestationContexts)[keyof typeof AttestationContexts];\n"]}

package/dist/es/models/attestationTypes.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of attestation data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const AttestationTypes = {
+    /**
+     * Represents attestation information.
+     */
+    Information: "Information",
+    /**
+     * Represents attestation JWT proof.
+     */
+    JwtProof: "JwtProof"
+};
+//# sourceMappingURL=attestationTypes.js.map

package/dist/es/models/attestationTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attestationTypes.js","sourceRoot":"","sources":["../../../src/models/attestationTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B;;OAEG;IACH,WAAW,EAAE,aAAa;IAE1B;;OAEG;IACH,QAAQ,EAAE,UAAU;CACX,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of attestation data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AttestationTypes = {\n\t/**\n\t * Represents attestation information.\n\t */\n\tInformation: \"Information\",\n\n\t/**\n\t * Represents attestation JWT proof.\n\t */\n\tJwtProof: \"JwtProof\"\n} as const;\n\n/**\n * The types of attestation data.\n */\nexport type AttestationTypes = (typeof AttestationTypes)[keyof typeof AttestationTypes];\n"]}

package/dist/es/schemas/AttestationInformation.json

@@ -0,0 +1,76 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/attestation/AttestationInformation",
+    "title": "AttestationInformation",
+    "description": "Interface describing the collated attestation information.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "prefixItems": [
+                {
+                    "const": "https://schema.org"
+                },
+                {
+                    "const": "https://schema.twindev.org/attestation/"
+                },
+                {
+                    "const": "https://schema.twindev.org/common/"
+                }
+            ],
+            "items": {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+            },
+            "minItems": 3,
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "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."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "id",
+        "dateCreated",
+        "ownerIdentity",
+        "attestationObject"
+    ]
+}

package/dist/es/schemas/AttestationJwtProof.json

@@ -0,0 +1,42 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/attestation/AttestationJwtProof",
+    "title": "AttestationJwtProof",
+    "description": "Interface describing an attestation proof.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "anyOf": [
+                {
+                    "const": "https://schema.twindev.org/attestation/"
+                },
+                {
+                    "type": "array",
+                    "prefixItems": [
+                        {
+                            "const": "https://schema.twindev.org/attestation/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    },
+                    "minItems": 1
+                }
+            ],
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "const": "JwtProof",
+            "description": "The type of the proof."
+        },
+        "value": {
+            "type": "string",
+            "description": "The value of the proof."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "value"
+    ]
+}

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

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IAttestationConnector } from "../models/IAttestationConnector";
+import type { IAttestationConnector } from "../models/IAttestationConnector.js";
 /**
  * Factory for creating attestation connectors.
  */

package/dist/types/index.d.ts

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

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IAttestationInformation } from "./IAttestationInformation";
+import type { IAttestationInformation } from "./IAttestationInformation.js";
 /**
  * Interface describing an attestation contract.
  */
@@ -9,11 +9,9 @@ export interface IAttestationComponent extends IComponent {
      * Attest the data and return the collated information.
      * @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 id of the attestation.
      */
-    create(attestationObject: IJsonLdNodeObject, namespace?: string, identity?: string, nodeIdentity?: string): Promise<string>;
+    create(attestationObject: IJsonLdNodeObject, namespace?: string): Promise<string>;
     /**
      * Resolve and verify the attestation id.
      * @param id The attestation id to verify.
@@ -25,15 +23,13 @@ export interface IAttestationComponent extends IComponent {
      * @param attestationId The attestation to transfer.
      * @param holderIdentity The identity to transfer the attestation to.
      * @param holderAddress The address to transfer the attestation to.
-     * @param identity The identity to perform the attestation operation with.
      * @returns Nothing.
      */
-    transfer(attestationId: string, holderIdentity: string, holderAddress: string, identity?: string): Promise<void>;
+    transfer(attestationId: string, holderIdentity: string, holderAddress: string): Promise<void>;
     /**
      * Destroy the attestation.
      * @param attestationId The attestation to transfer.
-     * @param identity The identity to perform the attestation operation with.
      * @returns Nothing.
      */
-    destroy(attestationId: string, identity?: string): Promise<void>;
+    destroy(attestationId: string): Promise<void>;
 }

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IAttestationInformation } from "./IAttestationInformation";
+import type { IAttestationInformation } from "./IAttestationInformation.js";
 /**
  * Interface describing an attestation connector.
  */

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

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
-import type { AttestationContexts } from "./attestationContexts";
-import type { AttestationTypes } from "./attestationTypes";
+import type { AttestationContexts } from "./attestationContexts.js";
+import type { AttestationTypes } from "./attestationTypes.js";
 /**
  * Interface describing the collated attestation information.
  */
@@ -10,9 +10,9 @@ export interface IAttestationInformation {
      * JSON-LD Context.
      */
     "@context": [
-        typeof AttestationContexts.ContextRoot,
-        typeof AttestationContexts.ContextRootCommon,
-        typeof SchemaOrgContexts.ContextRoot,
+        typeof SchemaOrgContexts.Context,
+        typeof AttestationContexts.Context,
+        typeof AttestationContexts.ContextCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**
@@ -25,34 +25,42 @@ export interface IAttestationInformation {
     id: string;
     /**
      * Created date/time of the attestation in ISO format.
+     * @json-ld namespace:schema
      */
     dateCreated: string;
     /**
      * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
+     * @json-ld type:schema:Date
      */
     dateTransferred?: string;
     /**
      * The identity of the owner.
+     * @json-ld type:schema:identifier
      */
     ownerIdentity: string;
     /**
      * The identity of the current holder, can be undefined if owner is still the holder.
+     * @json-ld type:schema:identifier
      */
     holderIdentity?: string;
     /**
      * The data that was attested.
+     * @json-ld namespace:twin-common
      */
     attestationObject: IJsonLdNodeObject;
     /**
      * The proof for the attested data.
+     * @json-ld namespace:twin-attestation
      */
     proof?: IJsonLdNodeObject;
     /**
      * Whether the attestation has been verified.
+     * @json-ld namespace:twin-common
      */
     verified?: boolean;
     /**
      * The verification failure message.
+     * @json-ld type:schema:Text
      */
     verificationFailure?: string;
 }

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

@@ -1,6 +1,6 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
-import type { AttestationContexts } from "./attestationContexts";
-import type { AttestationTypes } from "./attestationTypes";
+import type { AttestationContexts } from "./attestationContexts.js";
+import type { AttestationTypes } from "./attestationTypes.js";
 /**
  * Interface describing an attestation proof.
  */
@@ -8,13 +8,14 @@ export interface IAttestationJwtProof {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AttestationContexts.ContextRoot | [typeof AttestationContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    "@context": typeof AttestationContexts.Context | [typeof AttestationContexts.Context, ...IJsonLdContextDefinitionElement[]];
     /**
      * The type of the proof.
      */
     type: typeof AttestationTypes.JwtProof;
     /**
      * The value of the proof.
+     * @json-ld type:schema:Text
      */
     value: string;
 }

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

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IAttestationInformation } from "../IAttestationInformation";
+import type { IAttestationInformation } from "../IAttestationInformation.js";
 /**
  * The response to verifying the attestation.
  */

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

@@ -3,13 +3,29 @@
  */
 export declare const AttestationContexts: {
     /**
-     * The context root for the attestation types.
+     * The canonical RDF namespace URI for Attestation.
      */
-    readonly ContextRoot: "https://schema.twindev.org/attestation/";
+    readonly Namespace: "https://schema.twindev.org/attestation/";
     /**
-     * The context root for the common types.
+     * The value to use in context for Attestation.
      */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+    readonly Context: "https://schema.twindev.org/attestation/";
+    /**
+     * The JSON-LD Context URL for Attestation.
+     */
+    readonly JsonLdContext: "https://schema.twindev.org/attestation/types.jsonld";
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    readonly NamespaceCommon: "https://schema.twindev.org/common/";
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    readonly ContextCommon: "https://schema.twindev.org/common/";
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    readonly JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld";
 };
 /**
  * The contexts of attestation data.