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

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

@@ -1,4 +1,5 @@
 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 contract.
@@ -13,13 +14,13 @@ export interface IAttestationComponent extends IComponent {
      * @param nodeIdentity The node identity to include in the attestation.
      * @returns The collated attestation data.
      */
-    attest<T = unknown>(verificationMethodId: string, data: T, namespace?: string, identity?: string, nodeIdentity?: string): Promise<IAttestationInformation<T>>;
+    attest<T extends IJsonLdNodeObject = IJsonLdNodeObject>(verificationMethodId: string, data: T, namespace?: string, identity?: string, nodeIdentity?: string): Promise<IAttestationInformation<T>>;
     /**
      * Resolve and verify the attestation id.
      * @param attestationId The attestation id to verify.
      * @returns The verified attestation details.
      */
-    verify<T = unknown>(attestationId: string): Promise<{
+    verify<T extends IJsonLdNodeObject = IJsonLdNodeObject>(attestationId: string): Promise<{
         verified: boolean;
         failure?: string;
         information?: Partial<IAttestationInformation<T>>;
@@ -31,7 +32,7 @@ export interface IAttestationComponent extends IComponent {
      * @param identity The identity to perform the attestation operation with.
      * @returns The updated attestation details.
      */
-    transfer<T = unknown>(attestationId: string, holderIdentity: string, identity?: string): Promise<IAttestationInformation<T>>;
+    transfer<T extends IJsonLdNodeObject = IJsonLdNodeObject>(attestationId: string, holderIdentity: string, identity?: string): Promise<IAttestationInformation<T>>;
     /**
      * Destroy the attestation.
      * @param attestationId The attestation to transfer.

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

@@ -1,4 +1,5 @@
 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.
@@ -12,13 +13,13 @@ export interface IAttestationConnector extends IComponent {
      * @param data The data to attest.
      * @returns The collated attestation data.
      */
-    attest<T = unknown>(controller: string, address: string, verificationMethodId: string, data: T): Promise<IAttestationInformation<T>>;
+    attest<T extends IJsonLdNodeObject = IJsonLdNodeObject>(controller: string, address: string, verificationMethodId: string, data: T): Promise<IAttestationInformation<T>>;
     /**
      * Resolve and verify the attestation id.
      * @param attestationId The attestation id to verify.
      * @returns The verified attestation details.
      */
-    verify<T = unknown>(attestationId: string): Promise<{
+    verify<T extends IJsonLdNodeObject = IJsonLdNodeObject>(attestationId: string): Promise<{
         verified: boolean;
         failure?: string;
         information?: Partial<IAttestationInformation<T>>;
@@ -31,7 +32,7 @@ export interface IAttestationConnector extends IComponent {
      * @param holderAddress The new controller address of the attestation belonging to the holder.
      * @returns The updated attestation details.
      */
-    transfer<T = unknown>(controller: string, attestationId: string, holderIdentity: string, holderAddress: string): Promise<IAttestationInformation<T>>;
+    transfer<T extends IJsonLdNodeObject = IJsonLdNodeObject>(controller: string, attestationId: string, holderIdentity: string, holderAddress: string): Promise<IAttestationInformation<T>>;
     /**
      * Destroy the attestation.
      * @param controller The controller identity of the user to access the vault keys.

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

@@ -1,8 +1,9 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IAttestationProof } from "./IAttestationProof";
 /**
  * Interface describing the collated attestation information.
  */
-export interface IAttestationInformation<T = unknown> {
+export interface IAttestationInformation<T extends IJsonLdNodeObject = IJsonLdNodeObject> {
     /**
      * The unique identifier of the attestation.
      */

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

@@ -1,3 +1,4 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 /**
  * Attest the data and return the collated attestation details.
  */
@@ -13,7 +14,7 @@ export interface IAttestationAttestRequest {
         /**
          * The data object to attest.
          */
-        data: unknown;
+        data: IJsonLdNodeObject;
         /**
          * The namespace of the connector to use for the attestation, defaults to component configured namespace.
          */

package/docs/changelog.md

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

package/docs/reference/interfaces/IAttestationAttestRequest.md

@@ -18,7 +18,7 @@ The identity verification method to use for attesting the data.
 
 #### data
 
-> **data**: `unknown`
+> **data**: `IJsonLdNodeObject`
 
 The data object to attest.
 

package/docs/reference/interfaces/IAttestationAttestResponse.md

@@ -12,4 +12,4 @@ The result of the attestation process.
 
 #### information
 
-> **information**: [`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>
+> **information**: [`IAttestationInformation`](IAttestationInformation.md)\<`IJsonLdNodeObject`\>

package/docs/reference/interfaces/IAttestationComponent.md

@@ -16,7 +16,7 @@ Attest the data and return the collated information.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
 
 #### Parameters
 
@@ -56,7 +56,7 @@ Resolve and verify the attestation id.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
 
 #### Parameters
 
@@ -92,7 +92,7 @@ Transfer the attestation to a new holder.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
 
 #### Parameters
 

package/docs/reference/interfaces/IAttestationConnector.md

@@ -16,7 +16,7 @@ Attest the data and return the collated information.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
 
 #### Parameters
 
@@ -52,7 +52,7 @@ Resolve and verify the attestation id.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
 
 #### Parameters
 
@@ -88,7 +88,7 @@ Transfer the attestation to a new holder.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
 
 #### Parameters
 

package/docs/reference/interfaces/IAttestationInformation.md

@@ -4,7 +4,7 @@ Interface describing the collated attestation information.
 
 ## Type Parameters
 
-• **T** = `unknown`
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
 
 ## Properties
 

package/docs/reference/interfaces/IAttestationTransferResponse.md

@@ -12,6 +12,6 @@ The data returned from the transfer response.
 
 #### information
 
-> **information**: [`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>
+> **information**: [`IAttestationInformation`](IAttestationInformation.md)\<`IJsonLdNodeObject`\>
 
 The updated attestation information.

package/docs/reference/interfaces/IAttestationVerifyResponse.md

@@ -24,6 +24,6 @@ The failure message if the attestation is not verified.
 
 #### information?
 
-> `optional` **information**: `Partial`\<[`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>\>
+> `optional` **information**: `Partial`\<[`IAttestationInformation`](IAttestationInformation.md)\<`IJsonLdNodeObject`\>\>
 
 The attestation information.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/attestation-models",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.5",
 	"description": "Models which define the structure of the attestation connectors and services",
 	"repository": {
 		"type": "git",
@@ -13,38 +13,13 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage docs/reference",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next"
 	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.22.0",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",