@twin.org/trust-models 0.0.3-next.6 → 0.0.3-next.8

package/dist/es/helpers/trustHelper.js

@@ -1,6 +1,6 @@
 // Copyright 2025 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-import { UnauthorizedError } from "@twin.org/core";
+import { Is, UnauthorizedError } from "@twin.org/core";
 /**
  * Helper class for trust-related operations.
  */
@@ -19,7 +19,7 @@ export class TrustHelper {
      */
     static async verifyTrust(component, trustPayload, action, overrideVerifiers) {
         const trustResult = await component.verify(trustPayload, overrideVerifiers);
-        if (!trustResult.verified) {
+        if (!trustResult.verified || !Is.stringValue(trustResult.info?.identity)) {
             throw new UnauthorizedError(TrustHelper.CLASS_NAME, "trustVerifyFailed", {
                 action,
                 errors: trustResult.errors

package/dist/es/helpers/trustHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"trustHelper.js","sourceRoot":"","sources":["../../../src/helpers/trustHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAKnD;;GAEG;AACH,MAAM,OAAO,WAAW;IACvB;;OAEG;IACI,MAAM,CAAU,UAAU,iBAAiC;IAElE;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,SAA0B,EAC1B,YAAqB,EACrB,MAAc,EACd,iBAA4B;QAE5B,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;QAC5E,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,iBAAiB,CAAC,WAAW,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBACxE,MAAM;gBACN,MAAM,EAAE,WAAW,CAAC,MAAM;aAC1B,CAAC,CAAC;QACJ,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAC;IACzB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { UnauthorizedError } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { ITrustComponent } from \"../models/ITrustComponent.js\";\nimport type { ITrustVerificationInfo } from \"../models/ITrustVerificationInfo.js\";\n\n/**\n * Helper class for trust-related operations.\n */\nexport class TrustHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<TrustHelper>();\n\n\t/**\n\t * Verify the trust payload for the action.\n\t * @param component The trust component to use.\n\t * @param trustPayload The trust payload to verify.\n\t * @param action The action being performed.\n\t * @param overrideVerifiers List of verifiers to use instead of the default ones.\n\t * @returns The information from the trust verification.\n\t */\n\tpublic static async verifyTrust(\n\t\tcomponent: ITrustComponent,\n\t\ttrustPayload: unknown,\n\t\taction: string,\n\t\toverrideVerifiers?: string[]\n\t): Promise<ITrustVerificationInfo | undefined> {\n\t\tconst trustResult = await component.verify(trustPayload, overrideVerifiers);\n\t\tif (!trustResult.verified) {\n\t\t\tthrow new UnauthorizedError(TrustHelper.CLASS_NAME, \"trustVerifyFailed\", {\n\t\t\t\taction,\n\t\t\t\terrors: trustResult.errors\n\t\t\t});\n\t\t}\n\t\treturn trustResult.info;\n\t}\n}\n"]}
+{"version":3,"file":"trustHelper.js","sourceRoot":"","sources":["../../../src/helpers/trustHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAKvD;;GAEG;AACH,MAAM,OAAO,WAAW;IACvB;;OAEG;IACI,MAAM,CAAU,UAAU,iBAAiC;IAElE;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,SAA0B,EAC1B,YAAqB,EACrB,MAAc,EACd,iBAA4B;QAE5B,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;QAC5E,IAAI,CAAC,WAAW,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC;YAC1E,MAAM,IAAI,iBAAiB,CAAC,WAAW,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBACxE,MAAM;gBACN,MAAM,EAAE,WAAW,CAAC,MAAM;aAC1B,CAAC,CAAC;QACJ,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAC;IACzB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is, UnauthorizedError } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { ITrustComponent } from \"../models/ITrustComponent.js\";\nimport type { ITrustVerificationInfo } from \"../models/ITrustVerificationInfo.js\";\n\n/**\n * Helper class for trust-related operations.\n */\nexport class TrustHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<TrustHelper>();\n\n\t/**\n\t * Verify the trust payload for the action.\n\t * @param component The trust component to use.\n\t * @param trustPayload The trust payload to verify.\n\t * @param action The action being performed.\n\t * @param overrideVerifiers List of verifiers to use instead of the default ones.\n\t * @returns The information from the trust verification.\n\t */\n\tpublic static async verifyTrust(\n\t\tcomponent: ITrustComponent,\n\t\ttrustPayload: unknown,\n\t\taction: string,\n\t\toverrideVerifiers?: string[]\n\t): Promise<ITrustVerificationInfo> {\n\t\tconst trustResult = await component.verify(trustPayload, overrideVerifiers);\n\t\tif (!trustResult.verified || !Is.stringValue(trustResult.info?.identity)) {\n\t\t\tthrow new UnauthorizedError(TrustHelper.CLASS_NAME, \"trustVerifyFailed\", {\n\t\t\t\taction,\n\t\t\t\terrors: trustResult.errors\n\t\t\t});\n\t\t}\n\t\treturn trustResult.info;\n\t}\n}\n"]}

package/dist/es/models/ITrustVerificationInfo.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"ITrustVerificationInfo.js","sourceRoot":"","sources":["../../../src/models/ITrustVerificationInfo.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing a trust verifier information.\n */\nexport interface ITrustVerificationInfo {\n\t[key: string]: unknown;\n\n\t/**\n\t * The identity associated with the payload.\n\t */\n\tidentity: string;\n}\n"]}
+{"version":3,"file":"ITrustVerificationInfo.js","sourceRoot":"","sources":["../../../src/models/ITrustVerificationInfo.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a trust verifier information.\n */\nexport interface ITrustVerificationInfo {\n\t/**\n\t * The identity associated with the payload.\n\t */\n\tidentity: string;\n\n\t/**\n\t * Additional JSON-LD node objects associated with the verification.\n\t */\n\tdata?: {\n\t\t[key: string]: IJsonLdNodeObject;\n\t};\n}\n"]}

package/dist/types/helpers/trustHelper.d.ts

@@ -16,5 +16,5 @@ export declare class TrustHelper {
      * @param overrideVerifiers List of verifiers to use instead of the default ones.
      * @returns The information from the trust verification.
      */
-    static verifyTrust(component: ITrustComponent, trustPayload: unknown, action: string, overrideVerifiers?: string[]): Promise<ITrustVerificationInfo | undefined>;
+    static verifyTrust(component: ITrustComponent, trustPayload: unknown, action: string, overrideVerifiers?: string[]): Promise<ITrustVerificationInfo>;
 }

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

@@ -1,10 +1,16 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 /**
  * Interface describing a trust verifier information.
  */
 export interface ITrustVerificationInfo {
-    [key: string]: unknown;
     /**
      * The identity associated with the payload.
      */
     identity: string;
+    /**
+     * Additional JSON-LD node objects associated with the verification.
+     */
+    data?: {
+        [key: string]: IJsonLdNodeObject;
+    };
 }

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.3-next.8](https://github.com/twinfoundation/trust/compare/trust-models-v0.0.3-next.7...trust-models-v0.0.3-next.8) (2026-01-30)
+
+
+### Features
+
+* verification info structure ([#10](https://github.com/twinfoundation/trust/issues/10)) ([8b09ec8](https://github.com/twinfoundation/trust/commit/8b09ec8128214b659f427fc3a985eb8ced9ed5dc))
+
+## [0.0.3-next.7](https://github.com/twinfoundation/trust/compare/trust-models-v0.0.3-next.6...trust-models-v0.0.3-next.7) (2025-12-04)
+
+
+### Features
+
+* guarantee identity in helper return value ([8a582f3](https://github.com/twinfoundation/trust/commit/8a582f32125365a414dbd61c28dd870fb60d3acb))
+
 ## [0.0.3-next.6](https://github.com/twinfoundation/trust/compare/trust-models-v0.0.3-next.5...trust-models-v0.0.3-next.6) (2025-12-04)
 
 

package/docs/reference/classes/TrustHelper.md

@@ -24,7 +24,7 @@ Runtime name for the class.
 
 ### verifyTrust()
 
-> `static` **verifyTrust**(`component`, `trustPayload`, `action`, `overrideVerifiers?`): `Promise`\<[`ITrustVerificationInfo`](../interfaces/ITrustVerificationInfo.md) \| `undefined`\>
+> `static` **verifyTrust**(`component`, `trustPayload`, `action`, `overrideVerifiers?`): `Promise`\<[`ITrustVerificationInfo`](../interfaces/ITrustVerificationInfo.md)\>
 
 Verify the trust payload for the action.
 
@@ -56,6 +56,6 @@ List of verifiers to use instead of the default ones.
 
 #### Returns
 
-`Promise`\<[`ITrustVerificationInfo`](../interfaces/ITrustVerificationInfo.md) \| `undefined`\>
+`Promise`\<[`ITrustVerificationInfo`](../interfaces/ITrustVerificationInfo.md)\>
 
 The information from the trust verification.

package/docs/reference/interfaces/ITrustVerificationInfo.md

@@ -2,10 +2,6 @@
 
 Interface describing a trust verifier information.
 
-## Indexable
-
-\[`key`: `string`\]: `unknown`
-
 ## Properties
 
 ### identity
@@ -13,3 +9,15 @@ Interface describing a trust verifier information.
 > **identity**: `string`
 
 The identity associated with the payload.
+
+***
+
+### data?
+
+> `optional` **data**: `object`
+
+Additional JSON-LD node objects associated with the verification.
+
+#### Index Signature
+
+\[`key`: `string`\]: `IJsonLdNodeObject`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/trust-models",
-	"version": "0.0.3-next.6",
+	"version": "0.0.3-next.8",
 	"description": "Models which define the structure of the trust contracts",
 	"repository": {
 		"type": "git",
@@ -15,6 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "next",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/es/index.js",