@twin.org/identity-models 0.0.1-next.4 → 0.0.1-next.41

package/dist/types/utils/documentHelper.d.ts

@@ -1,14 +1,45 @@
+import { DidVerificationMethodType, type IDidDocumentVerificationMethod, type IDidDocument } from "@twin.org/standards-w3c-did";
+import type { IJwk } from "@twin.org/web";
 /**
  * Helper methods for documents.
  */
 export declare class DocumentHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Parse the document id into its parts.
      * @param documentId The full document id.
      * @returns The parsed document id.
      */
-    static parse(documentId: string): {
+    static parseId(documentId: string): {
         id: string;
-        hash: string | undefined;
+        fragment: string | undefined;
     };
+    /**
+     * Join the document id parts.
+     * @param documentId The document id.
+     * @param fragment The fragment part for the identifier.
+     * @returns The full id.
+     */
+    static joinId(documentId: string, fragment?: string): string;
+    /**
+     * Get a verification method from a DID document.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The verification method if found.
+     * @throws Error if the method is not found.
+     */
+    static getVerificationMethod(didDocument: IDidDocument, methodName: string, methodType?: DidVerificationMethodType): IDidDocumentVerificationMethod;
+    /**
+     * Gets a JWK from a DID document verification method.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The JWK if found.
+     * @throws Error if the method is not found.
+     */
+    static getJwk(didDocument: IDidDocument, methodName: string, methodType?: DidVerificationMethodType): IJwk;
 }

package/dist/types/utils/verificationHelper.d.ts

@@ -0,0 +1,29 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IJwtHeader, type IJwtPayload } from "@twin.org/web";
+import type { IIdentityResolverComponent } from "../models/IIdentityResolverComponent";
+/**
+ * Helper methods for verification.
+ */
+export declare class VerificationHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Verified the JWT.
+     * @param resolver The resolver to use for finding the document.
+     * @param jwt The token to verify.
+     * @returns The decoded payload.
+     */
+    static verifyJwt<T extends IJwtHeader, U extends IJwtPayload>(resolver: IIdentityResolverComponent, jwt: string): Promise<{
+        header: T;
+        payload: U;
+    }>;
+    /**
+     * Verified the proof for the document e.g. verifiable credential.
+     * @param resolver The resolver to use for finding the document.
+     * @param secureDocument The secure document to verify.
+     * @returns True if the verification is successful.
+     */
+    static verifyProof(resolver: IIdentityResolverComponent, secureDocument: IJsonLdNodeObject): Promise<boolean>;
+}

package/docs/changelog.md

@@ -1,5 +1,21 @@
 # @twin.org/identity-service-models - Changelog
 
-## v0.0.1-next.4
+## [0.0.1-next.41](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.1-next.40...identity-models-v0.0.1-next.41) (2025-04-09)
+
+
+### Miscellaneous Chores
+
+* **identity-models:** Synchronize repo versions
+
+## [0.0.1-next.40](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.1-next.39...identity-models-v0.0.1-next.40) (2025-03-28)
+
+
+### Bug Fixes
+
+* Import path and bump version ([#21](https://github.com/twinfoundation/identity/issues/21)) ([ccea845](https://github.com/twinfoundation/identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
+* Install sdk-wasm ([#20](https://github.com/twinfoundation/identity/issues/20)) ([75ec14e](https://github.com/twinfoundation/identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
+* Use resolver component ([#22](https://github.com/twinfoundation/identity/issues/22)) ([d0b3a32](https://github.com/twinfoundation/identity/commit/d0b3a321c7f9f966d397a880d752e9f2c0a98a27))
+
+## v0.0.1-next.39
 
 - Initial Release

package/docs/reference/classes/DocumentHelper.md

@@ -12,17 +12,27 @@ Helper methods for documents.
 
 [`DocumentHelper`](DocumentHelper.md)
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### parse()
+### parseId()
 
-> `static` **parse**(`documentId`): `object`
+> `static` **parseId**(`documentId`): `object`
 
 Parse the document id into its parts.
 
 #### Parameters
 
-• **documentId**: `string`
+##### documentId
+
+`string`
 
 The full document id.
 
@@ -36,6 +46,110 @@ The parsed document id.
 
 > **id**: `string`
 
-##### hash
+##### fragment
+
+> **fragment**: `undefined` \| `string`
+
+***
+
+### joinId()
+
+> `static` **joinId**(`documentId`, `fragment`?): `string`
+
+Join the document id parts.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The document id.
+
+##### fragment?
+
+`string`
+
+The fragment part for the identifier.
+
+#### Returns
+
+`string`
+
+The full id.
+
+***
+
+### getVerificationMethod()
+
+> `static` **getVerificationMethod**(`didDocument`, `methodName`, `methodType`?): `IDidDocumentVerificationMethod`
+
+Get a verification method from a DID document.
+
+#### Parameters
+
+##### didDocument
+
+`IDidDocument`
+
+The DID Document to get the method from.
+
+##### methodName
+
+`string`
+
+The name of the method to get the JWK from.
+
+##### methodType?
+
+`DidVerificationMethodType`
+
+The type of the method, defaults to verificationMethod.
+
+#### Returns
+
+`IDidDocumentVerificationMethod`
+
+The verification method if found.
+
+#### Throws
+
+Error if the method is not found.
+
+***
+
+### getJwk()
+
+> `static` **getJwk**(`didDocument`, `methodName`, `methodType`?): `IJwk`
+
+Gets a JWK from a DID document verification method.
+
+#### Parameters
+
+##### didDocument
+
+`IDidDocument`
+
+The DID Document to get the method from.
+
+##### methodName
+
+`string`
+
+The name of the method to get the JWK from.
+
+##### methodType?
+
+`DidVerificationMethodType`
+
+The type of the method, defaults to verificationMethod.
+
+#### Returns
+
+`IJwk`
+
+The JWK if found.
+
+#### Throws
 
-> **hash**: `undefined` \| `string`
+Error if the method is not found.

package/docs/reference/classes/VerificationHelper.md

@@ -0,0 +1,83 @@
+# Class: VerificationHelper
+
+Helper methods for verification.
+
+## Constructors
+
+### new VerificationHelper()
+
+> **new VerificationHelper**(): [`VerificationHelper`](VerificationHelper.md)
+
+#### Returns
+
+[`VerificationHelper`](VerificationHelper.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### verifyJwt()
+
+> `static` **verifyJwt**\<`T`, `U`\>(`resolver`, `jwt`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+Verified the JWT.
+
+#### Type Parameters
+
+• **T** *extends* `IJwtHeader`
+
+• **U** *extends* `IJwtPayload`
+
+#### Parameters
+
+##### resolver
+
+[`IIdentityResolverComponent`](../interfaces/IIdentityResolverComponent.md)
+
+The resolver to use for finding the document.
+
+##### jwt
+
+`string`
+
+The token to verify.
+
+#### Returns
+
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+The decoded payload.
+
+***
+
+### verifyProof()
+
+> `static` **verifyProof**(`resolver`, `secureDocument`): `Promise`\<`boolean`\>
+
+Verified the proof for the document e.g. verifiable credential.
+
+#### Parameters
+
+##### resolver
+
+[`IIdentityResolverComponent`](../interfaces/IIdentityResolverComponent.md)
+
+The resolver to use for finding the document.
+
+##### secureDocument
+
+`IJsonLdNodeObject`
+
+The secure document to verify.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the verification is successful.

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [DocumentHelper](classes/DocumentHelper.md)
+- [VerificationHelper](classes/VerificationHelper.md)
 
 ## Interfaces
 
@@ -10,6 +11,30 @@
 - [IIdentityConnector](interfaces/IIdentityConnector.md)
 - [IIdentityProfileComponent](interfaces/IIdentityProfileComponent.md)
 - [IIdentityProfileConnector](interfaces/IIdentityProfileConnector.md)
+- [IIdentityResolverComponent](interfaces/IIdentityResolverComponent.md)
+- [IIdentityResolverConnector](interfaces/IIdentityResolverConnector.md)
+- [IIdentityCreateRequest](interfaces/IIdentityCreateRequest.md)
+- [IIdentityCreateResponse](interfaces/IIdentityCreateResponse.md)
+- [IIdentityProofCreateRequest](interfaces/IIdentityProofCreateRequest.md)
+- [IIdentityProofCreateResponse](interfaces/IIdentityProofCreateResponse.md)
+- [IIdentityProofVerifyRequest](interfaces/IIdentityProofVerifyRequest.md)
+- [IIdentityProofVerifyResponse](interfaces/IIdentityProofVerifyResponse.md)
+- [IIdentityServiceCreateRequest](interfaces/IIdentityServiceCreateRequest.md)
+- [IIdentityServiceCreateResponse](interfaces/IIdentityServiceCreateResponse.md)
+- [IIdentityServiceRemoveRequest](interfaces/IIdentityServiceRemoveRequest.md)
+- [IIdentityVerifiableCredentialCreateRequest](interfaces/IIdentityVerifiableCredentialCreateRequest.md)
+- [IIdentityVerifiableCredentialCreateResponse](interfaces/IIdentityVerifiableCredentialCreateResponse.md)
+- [IIdentityVerifiableCredentialRevokeRequest](interfaces/IIdentityVerifiableCredentialRevokeRequest.md)
+- [IIdentityVerifiableCredentialUnrevokeRequest](interfaces/IIdentityVerifiableCredentialUnrevokeRequest.md)
+- [IIdentityVerifiableCredentialVerifyRequest](interfaces/IIdentityVerifiableCredentialVerifyRequest.md)
+- [IIdentityVerifiableCredentialVerifyResponse](interfaces/IIdentityVerifiableCredentialVerifyResponse.md)
+- [IIdentityVerifiablePresentationCreateRequest](interfaces/IIdentityVerifiablePresentationCreateRequest.md)
+- [IIdentityVerifiablePresentationCreateResponse](interfaces/IIdentityVerifiablePresentationCreateResponse.md)
+- [IIdentityVerifiablePresentationVerifyRequest](interfaces/IIdentityVerifiablePresentationVerifyRequest.md)
+- [IIdentityVerifiablePresentationVerifyResponse](interfaces/IIdentityVerifiablePresentationVerifyResponse.md)
+- [IIdentityVerificationMethodCreateRequest](interfaces/IIdentityVerificationMethodCreateRequest.md)
+- [IIdentityVerificationMethodCreateResponse](interfaces/IIdentityVerificationMethodCreateResponse.md)
+- [IIdentityVerificationMethodRemoveRequest](interfaces/IIdentityVerificationMethodRemoveRequest.md)
 - [IIdentityProfileCreateRequest](interfaces/IIdentityProfileCreateRequest.md)
 - [IIdentityProfileGetPublicRequest](interfaces/IIdentityProfileGetPublicRequest.md)
 - [IIdentityProfileGetPublicResponse](interfaces/IIdentityProfileGetPublicResponse.md)
@@ -21,12 +46,8 @@
 - [IIdentityResolveRequest](interfaces/IIdentityResolveRequest.md)
 - [IIdentityResolveResponse](interfaces/IIdentityResolveResponse.md)
 
-## Type Aliases
-
-- [IdentityRole](type-aliases/IdentityRole.md)
-
 ## Variables
 
 - [IdentityConnectorFactory](variables/IdentityConnectorFactory.md)
 - [IdentityProfileConnectorFactory](variables/IdentityProfileConnectorFactory.md)
-- [IdentityRole](variables/IdentityRole.md)
+- [IdentityResolverConnectorFactory](variables/IdentityResolverConnectorFactory.md)