@twin.org/trust-models 0.0.3-next.5 → 0.0.3-next.7

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;AAInD;;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\";\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<{ [key: string]: unknown } | 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/index.js

@@ -5,5 +5,6 @@ export * from "./factories/trustVerifierFactory.js";
 export * from "./helpers/trustHelper.js";
 export * from "./models/ITrustComponent.js";
 export * from "./models/ITrustGenerator.js";
+export * from "./models/ITrustVerificationInfo.js";
 export * from "./models/ITrustVerifier.js";
 //# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/trustGeneratorFactory.js\";\nexport * from \"./factories/trustVerifierFactory.js\";\nexport * from \"./helpers/trustHelper.js\";\nexport * from \"./models/ITrustComponent.js\";\nexport * from \"./models/ITrustGenerator.js\";\nexport * from \"./models/ITrustVerifier.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,4BAA4B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/trustGeneratorFactory.js\";\nexport * from \"./factories/trustVerifierFactory.js\";\nexport * from \"./helpers/trustHelper.js\";\nexport * from \"./models/ITrustComponent.js\";\nexport * from \"./models/ITrustGenerator.js\";\nexport * from \"./models/ITrustVerificationInfo.js\";\nexport * from \"./models/ITrustVerifier.js\";\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"ITrustComponent.js","sourceRoot":"","sources":["../../../src/models/ITrustComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent, IError } from \"@twin.org/core\";\n\n/**\n * Interface describing a trust component.\n */\nexport interface ITrustComponent extends IComponent {\n\t/**\n\t * Verify a payload by checking the validity of its structure and content using the registered verifiers.\n\t * @param payload The payload to verify.\n\t * @param overrideVerifiers List of verifiers to use instead of the default ones.\n\t * @returns Whether the payload is verified and any additional information extracted from the payload, or errors.\n\t */\n\tverify(\n\t\tpayload: unknown,\n\t\toverrideVerifiers?: string[]\n\t): Promise<{\n\t\tverified: boolean;\n\t\tinfo?: { [key: string]: unknown };\n\t\terrors?: IError[];\n\t}>;\n\n\t/**\n\t * Generate a payload using the specified generators.\n\t * @param identity The identity for which to generate the payload.\n\t * @param generatorType The type of generator to use, defaults to the default generator type or first in factory.\n\t * @param info Optional information to include in the generated payload.\n\t * @returns The generated payload.\n\t */\n\tgenerate(\n\t\tidentity: string,\n\t\tgeneratorType?: string,\n\t\tinfo?: { [key: string]: unknown }\n\t): Promise<unknown>;\n}\n"]}
+{"version":3,"file":"ITrustComponent.js","sourceRoot":"","sources":["../../../src/models/ITrustComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent, IError } from \"@twin.org/core\";\nimport type { ITrustVerificationInfo } from \"./ITrustVerificationInfo.js\";\n\n/**\n * Interface describing a trust component.\n */\nexport interface ITrustComponent extends IComponent {\n\t/**\n\t * Verify a payload by checking the validity of its structure and content using the registered verifiers.\n\t * @param payload The payload to verify.\n\t * @param overrideVerifiers List of verifiers to use instead of the default ones.\n\t * @returns Whether the payload is verified and any additional information extracted from the payload, or errors.\n\t */\n\tverify(\n\t\tpayload: unknown,\n\t\toverrideVerifiers?: string[]\n\t): Promise<{\n\t\tverified: boolean;\n\t\tinfo?: ITrustVerificationInfo;\n\t\terrors?: IError[];\n\t}>;\n\n\t/**\n\t * Generate a payload using the specified generators.\n\t * @param identity The identity for which to generate the payload.\n\t * @param generatorType The type of generator to use, defaults to the default generator type or first in factory.\n\t * @param info Optional information to include in the generated payload.\n\t * @returns The generated payload.\n\t */\n\tgenerate(\n\t\tidentity: string,\n\t\tgeneratorType?: string,\n\t\tinfo?: { [key: string]: unknown }\n\t): Promise<unknown>;\n}\n"]}

package/dist/es/models/ITrustVerificationInfo.js

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

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

@@ -0,0 +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"]}

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

@@ -1 +1 @@
-{"version":3,"file":"ITrustVerifier.js","sourceRoot":"","sources":["../../../src/models/ITrustVerifier.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent, IError } from \"@twin.org/core\";\n\n/**\n * Interface describing a trust verifier component.\n */\nexport interface ITrustVerifier extends IComponent {\n\t/**\n\t * Verify a payload by checking the validity of its structure and content.\n\t * @param payload The payload to verify.\n\t * @param info Information extracted from previous verifiers and to be added by this verifier.\n\t * @param errors Array to collect verification errors.\n\t * @returns Whether the payload is verified, returns undefined if payload was not processed.\n\t */\n\tverify(\n\t\tpayload: unknown,\n\t\tinfo: {\n\t\t\t[key: string]: unknown;\n\t\t},\n\t\terrors: IError[]\n\t): Promise<boolean | undefined>;\n}\n"]}
+{"version":3,"file":"ITrustVerifier.js","sourceRoot":"","sources":["../../../src/models/ITrustVerifier.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent, IError } from \"@twin.org/core\";\nimport type { ITrustVerificationInfo } from \"./ITrustVerificationInfo.js\";\n\n/**\n * Interface describing a trust verifier component.\n */\nexport interface ITrustVerifier extends IComponent {\n\t/**\n\t * Verify a payload by checking the validity of its structure and content.\n\t * @param payload The payload to verify.\n\t * @param info Information extracted from previous verifiers and to be added by this verifier.\n\t * @param info.identity The identity associated with the payload.\n\t * @param errors Array to collect verification errors.\n\t * @returns Whether the payload is verified, returns undefined if payload was not processed.\n\t */\n\tverify(\n\t\tpayload: unknown,\n\t\tinfo: ITrustVerificationInfo,\n\t\terrors: IError[]\n\t): Promise<boolean | undefined>;\n}\n"]}

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

@@ -1,4 +1,5 @@
 import type { ITrustComponent } from "../models/ITrustComponent.js";
+import type { ITrustVerificationInfo } from "../models/ITrustVerificationInfo.js";
 /**
  * Helper class for trust-related operations.
  */
@@ -15,7 +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<{
-        [key: string]: unknown;
-    } | undefined>;
+    static verifyTrust(component: ITrustComponent, trustPayload: unknown, action: string, overrideVerifiers?: string[]): Promise<ITrustVerificationInfo>;
 }

package/dist/types/index.d.ts

@@ -3,4 +3,5 @@ export * from "./factories/trustVerifierFactory.js";
 export * from "./helpers/trustHelper.js";
 export * from "./models/ITrustComponent.js";
 export * from "./models/ITrustGenerator.js";
+export * from "./models/ITrustVerificationInfo.js";
 export * from "./models/ITrustVerifier.js";

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

@@ -1,4 +1,5 @@
 import type { IComponent, IError } from "@twin.org/core";
+import type { ITrustVerificationInfo } from "./ITrustVerificationInfo.js";
 /**
  * Interface describing a trust component.
  */
@@ -11,9 +12,7 @@ export interface ITrustComponent extends IComponent {
      */
     verify(payload: unknown, overrideVerifiers?: string[]): Promise<{
         verified: boolean;
-        info?: {
-            [key: string]: unknown;
-        };
+        info?: ITrustVerificationInfo;
         errors?: IError[];
     }>;
     /**

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

@@ -0,0 +1,10 @@
+/**
+ * Interface describing a trust verifier information.
+ */
+export interface ITrustVerificationInfo {
+    [key: string]: unknown;
+    /**
+     * The identity associated with the payload.
+     */
+    identity: string;
+}

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

@@ -1,4 +1,5 @@
 import type { IComponent, IError } from "@twin.org/core";
+import type { ITrustVerificationInfo } from "./ITrustVerificationInfo.js";
 /**
  * Interface describing a trust verifier component.
  */
@@ -7,10 +8,9 @@ export interface ITrustVerifier extends IComponent {
      * Verify a payload by checking the validity of its structure and content.
      * @param payload The payload to verify.
      * @param info Information extracted from previous verifiers and to be added by this verifier.
+     * @param info.identity The identity associated with the payload.
      * @param errors Array to collect verification errors.
      * @returns Whether the payload is verified, returns undefined if payload was not processed.
      */
-    verify(payload: unknown, info: {
-        [key: string]: unknown;
-    }, errors: IError[]): Promise<boolean | undefined>;
+    verify(payload: unknown, info: ITrustVerificationInfo, errors: IError[]): Promise<boolean | undefined>;
 }

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* always include identity in verification info ([9594d19](https://github.com/twinfoundation/trust/commit/9594d19e9d718bd42b82964750ae3bcfb7df51bf))
+
 ## [0.0.3-next.5](https://github.com/twinfoundation/trust/compare/trust-models-v0.0.3-next.4...trust-models-v0.0.3-next.5) (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`\<\{\[`key`: `string`\]: `unknown`; \} \| `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`\<\{\[`key`: `string`\]: `unknown`; \} \| `undefined`\>
+`Promise`\<[`ITrustVerificationInfo`](../interfaces/ITrustVerificationInfo.md)\>
 
 The information from the trust verification.

package/docs/reference/index.md

@@ -8,6 +8,7 @@
 
 - [ITrustComponent](interfaces/ITrustComponent.md)
 - [ITrustGenerator](interfaces/ITrustGenerator.md)
+- [ITrustVerificationInfo](interfaces/ITrustVerificationInfo.md)
 - [ITrustVerifier](interfaces/ITrustVerifier.md)
 
 ## Variables

package/docs/reference/interfaces/ITrustComponent.md

@@ -10,7 +10,7 @@ Interface describing a trust component.
 
 ### verify()
 
-> **verify**(`payload`, `overrideVerifiers?`): `Promise`\<\{ `verified`: `boolean`; `info?`: \{\[`key`: `string`\]: `unknown`; \}; `errors?`: `IError`[]; \}\>
+> **verify**(`payload`, `overrideVerifiers?`): `Promise`\<\{ `verified`: `boolean`; `info?`: [`ITrustVerificationInfo`](ITrustVerificationInfo.md); `errors?`: `IError`[]; \}\>
 
 Verify a payload by checking the validity of its structure and content using the registered verifiers.
 
@@ -30,7 +30,7 @@ List of verifiers to use instead of the default ones.
 
 #### Returns
 
-`Promise`\<\{ `verified`: `boolean`; `info?`: \{\[`key`: `string`\]: `unknown`; \}; `errors?`: `IError`[]; \}\>
+`Promise`\<\{ `verified`: `boolean`; `info?`: [`ITrustVerificationInfo`](ITrustVerificationInfo.md); `errors?`: `IError`[]; \}\>
 
 Whether the payload is verified and any additional information extracted from the payload, or errors.
 

package/docs/reference/interfaces/ITrustVerificationInfo.md

@@ -0,0 +1,15 @@
+# Interface: ITrustVerificationInfo
+
+Interface describing a trust verifier information.
+
+## Indexable
+
+\[`key`: `string`\]: `unknown`
+
+## Properties
+
+### identity
+
+> **identity**: `string`
+
+The identity associated with the payload.

package/docs/reference/interfaces/ITrustVerifier.md

@@ -24,6 +24,8 @@ The payload to verify.
 
 ##### info
 
+[`ITrustVerificationInfo`](ITrustVerificationInfo.md)
+
 Information extracted from previous verifiers and to be added by this verifier.
 
 ##### errors

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/trust-models",
-	"version": "0.0.3-next.5",
+	"version": "0.0.3-next.7",
 	"description": "Models which define the structure of the trust contracts",
 	"repository": {
 		"type": "git",