@twin.org/identity-models 0.0.3-next.9 → 0.9.0

package/dist/types/index.d.ts

@@ -2,6 +2,8 @@ export * from "./contextIdHandlers/didContextIdHandler.js";
 export * from "./factories/identityConnectorFactory.js";
 export * from "./factories/identityProfileConnectorFactory.js";
 export * from "./factories/identityResolverConnectorFactory.js";
+export * from "./models/api/identity/IIdentityAlsoKnownAsCreateRequest.js";
+export * from "./models/api/identity/IIdentityAlsoKnownAsRemoveRequest.js";
 export * from "./models/api/identity/IIdentityCreateRequest.js";
 export * from "./models/api/identity/IIdentityCreateResponse.js";
 export * from "./models/api/identity/IIdentityProofCreateRequest.js";
@@ -16,10 +18,12 @@ export * from "./models/api/identity/IIdentityVerifiableCredentialCreateRequest.
 export * from "./models/api/identity/IIdentityVerifiableCredentialCreateResponse.js";
 export * from "./models/api/identity/IIdentityVerifiableCredentialRevokeRequest.js";
 export * from "./models/api/identity/IIdentityVerifiableCredentialUnrevokeRequest.js";
+export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyDocumentRequest.js";
 export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyRequest.js";
 export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyResponse.js";
 export * from "./models/api/identity/IIdentityVerifiablePresentationCreateRequest.js";
 export * from "./models/api/identity/IIdentityVerifiablePresentationCreateResponse.js";
+export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyDocumentRequest.js";
 export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyRequest.js";
 export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyResponse.js";
 export * from "./models/api/identity/IIdentityVerificationMethodCreateRequest.js";
@@ -41,6 +45,8 @@ export * from "./models/IIdentityProfileComponent.js";
 export * from "./models/IIdentityProfileConnector.js";
 export * from "./models/IIdentityResolverComponent.js";
 export * from "./models/IIdentityResolverConnector.js";
+export * from "./models/identityMetricIds.js";
+export * from "./models/identityMetrics.js";
 export * from "./types/did.js";
 export * from "./utils/documentHelper.js";
 export * from "./utils/verificationHelper.js";

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

@@ -16,7 +16,7 @@ export interface IIdentityComponent extends IComponent {
      * Remove an identity.
      * @param identity The id of the document to remove.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the identity has been removed.
      */
     identityRemove(identity: string, controller?: string): Promise<void>;
     /**
@@ -34,7 +34,7 @@ export interface IIdentityComponent extends IComponent {
      * Remove a verification method from the document.
      * @param verificationMethodId The id of the verification method.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the verification method has been removed.
      * @throws NotFoundError if the id can not be resolved.
      * @throws NotSupportedError if the platform does not support multiple revocable keys.
      */
@@ -54,10 +54,32 @@ export interface IIdentityComponent extends IComponent {
      * Remove a service from the document.
      * @param serviceId The id of the service.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the service has been removed.
      * @throws NotFoundError if the id can not be resolved.
      */
     serviceRemove(serviceId: string, controller?: string): Promise<void>;
+    /**
+     * Add an alias to the alsoKnownAs property on the document.
+     * If the alias is already present the operation is a no-op.
+     * @param documentId The id of the document to update.
+     * @param alias The alias to add. Must be a Url or Urn (typically another DID).
+     * @param controller The controller of the identity who can make changes.
+     * @returns A promise that resolves when the alias has been added.
+     * @throws GeneralError if the alias is not a Url or Urn.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    alsoKnownAsAdd(documentId: string, alias: string, controller?: string): Promise<void>;
+    /**
+     * Remove an alias from the alsoKnownAs property on the document.
+     * If the alias is not present the operation is a no-op.
+     * @param documentId The id of the document to update.
+     * @param alias The alias to remove. Must be a Url or Urn.
+     * @param controller The controller of the identity who can make changes.
+     * @returns A promise that resolves when the alias has been removed.
+     * @throws GeneralError if the alias is not a Url or Urn.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    alsoKnownAsRemove(documentId: string, alias: string, controller?: string): Promise<void>;
     /**
      * Create a verifiable credential for a verification method.
      * @param verificationMethodId The verification method id to use.
@@ -66,6 +88,8 @@ export interface IIdentityComponent extends IComponent {
      * @param options Additional options for creating the verifiable credential.
      * @param options.revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
      * @param options.expirationDate The date the verifiable credential is valid until.
+     * @param options.jwtHeaderFields Additional fields to include in the JWT header when creating the verifiable credential in jwt format.
+     * @param options.jwtPayloadFields Additional fields to include in the JWT payload when creating the verifiable credential in jwt format.
      * @param controller The controller of the identity who can make changes.
      * @returns The created verifiable credential and its token.
      * @throws NotFoundError if the id can not be resolved.
@@ -73,33 +97,39 @@ export interface IIdentityComponent extends IComponent {
     verifiableCredentialCreate(verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, options?: {
         revocationIndex?: number;
         expirationDate?: Date;
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
     }, controller?: string): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
     /**
      * Verify a verifiable credential is valid.
-     * @param credentialJwt The credential to verify.
+     * @param credential The credential to verify.
      * @returns The credential stored in the jwt and the revocation status.
      */
-    verifiableCredentialVerify(credentialJwt: string): Promise<{
+    verifiableCredentialVerify(credential: string | IDidVerifiableCredential): Promise<{
         revoked: boolean;
         verifiableCredential?: IDidVerifiableCredential;
     }>;
     /**
      * Revoke verifiable credential.
      * @param issuerId The id of the document to update the revocation list for.
-     * @param credentialIndex The revocation bitmap index revoke.
+     * @param credentialIndex The revocation bitmap index to revoke.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the credential has been revoked.
      */
     verifiableCredentialRevoke(issuerId: string, credentialIndex: number, controller?: string): Promise<void>;
     /**
      * Unrevoke verifiable credential.
      * @param issuerId The id of the document to update the revocation list for.
-     * @param credentialIndex The revocation bitmap index to un revoke.
+     * @param credentialIndex The revocation bitmap index to unrevoke.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the credential has been unrevoked.
      */
     verifiableCredentialUnrevoke(issuerId: string, credentialIndex: number, controller?: string): Promise<void>;
     /**
@@ -109,21 +139,32 @@ export interface IIdentityComponent extends IComponent {
      * @param contexts The contexts for the data stored in the verifiable credential.
      * @param types The types for the data stored in the verifiable credential.
      * @param verifiableCredentials The credentials to use for creating the presentation in jwt format.
-     * @param expiresInMinutes The time in minutes for the presentation to expire.
+     * @param options Additional options for creating the verifiable presentation.
+     * @param options.expirationDate The date the verifiable presentation is valid until.
+     * @param options.jwtHeaderFields Additional fields to include in the JWT header when creating the verifiable presentation in jwt format.
+     * @param options.jwtPayloadFields	Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format.
      * @param controller The controller of the identity who can make changes.
      * @returns The created verifiable presentation and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    verifiablePresentationCreate(verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number, controller?: string): Promise<{
+    verifiablePresentationCreate(verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], options?: {
+        expirationDate?: Date;
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
+    }, controller?: string): Promise<{
         verifiablePresentation: IDidVerifiablePresentation;
         jwt: string;
     }>;
     /**
      * Verify a verifiable presentation is valid.
-     * @param presentationJwt The presentation to verify.
+     * @param presentation The presentation to verify.
      * @returns The presentation stored in the jwt and the revocation status.
      */
-    verifiablePresentationVerify(presentationJwt: string): Promise<{
+    verifiablePresentationVerify(presentation: string | IDidVerifiablePresentation): Promise<{
         revoked: boolean;
         verifiablePresentation?: IDidVerifiablePresentation;
         issuers?: IDidDocument[];

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

@@ -15,7 +15,7 @@ export interface IIdentityConnector extends IComponent {
      * Remove a document.
      * @param controller The controller of the identity who can make changes.
      * @param documentId The id of the document to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the document has been removed.
      */
     removeDocument(controller: string, documentId: string): Promise<void>;
     /**
@@ -33,7 +33,7 @@ export interface IIdentityConnector extends IComponent {
      * Remove a verification method from the document.
      * @param controller The controller of the identity who can make changes.
      * @param verificationMethodId The id of the verification method.
-     * @returns Nothing.
+     * @returns A promise that resolves when the verification method has been removed.
      * @throws NotFoundError if the id can not be resolved.
      * @throws NotSupportedError if the platform does not support multiple revocable keys.
      */
@@ -53,10 +53,32 @@ export interface IIdentityConnector extends IComponent {
      * Remove a service from the document.
      * @param controller The controller of the identity who can make changes.
      * @param serviceId The id of the service.
-     * @returns Nothing.
+     * @returns A promise that resolves when the service has been removed.
      * @throws NotFoundError if the id can not be resolved.
      */
     removeService(controller: string, serviceId: string): Promise<void>;
+    /**
+     * Add an alias to the alsoKnownAs property on the document.
+     * If the alias is already present the operation is a no-op.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to update.
+     * @param alias The alias to add. Must be a Url or Urn (typically another DID).
+     * @returns A promise that resolves when the alias has been added.
+     * @throws GeneralError if the alias is not a Url or Urn.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    addAlsoKnownAs(controller: string, documentId: string, alias: string): Promise<void>;
+    /**
+     * Remove an alias from the alsoKnownAs property on the document.
+     * If the alias is not present the operation is a no-op.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to update.
+     * @param alias The alias to remove. Must be a Url or Urn.
+     * @returns A promise that resolves when the alias has been removed.
+     * @throws GeneralError if the alias is not a Url or Urn.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    removeAlsoKnownAs(controller: string, documentId: string, alias: string): Promise<void>;
     /**
      * Create a verifiable credential for a verification method.
      * @param controller The controller of the identity who can make changes.
@@ -66,22 +88,30 @@ export interface IIdentityConnector extends IComponent {
      * @param options Additional options for creating the verifiable credential.
      * @param options.revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
      * @param options.expirationDate The date the verifiable credential is valid until.
+     * @param options.jwtHeaderFields Additional fields to include in the JWT header when creating the verifiable credential in jwt format.
+     * @param options.jwtPayloadFields	Additional fields to include in the JWT payload when creating the verifiable credential in jwt format.
      * @returns The created verifiable credential and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
     createVerifiableCredential(controller: string, verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, options?: {
         revocationIndex?: number;
         expirationDate?: Date;
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
     }): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
     /**
      * Check a verifiable credential is valid.
-     * @param credentialJwt The credential to verify.
+     * @param credential The credential to verify.
      * @returns The credential stored in the jwt and the revocation status.
      */
-    checkVerifiableCredential(credentialJwt: string): Promise<{
+    checkVerifiableCredential(credential: string | IDidVerifiableCredential): Promise<{
         revoked: boolean;
         verifiableCredential?: IDidVerifiableCredential;
     }>;
@@ -90,15 +120,15 @@ export interface IIdentityConnector extends IComponent {
      * @param controller The controller of the identity who can make changes.
      * @param issuerDocumentId The id of the document to update the revocation list for.
      * @param credentialIndices The revocation bitmap index or indices to revoke.
-     * @returns Nothing.
+     * @returns A promise that resolves when the credentials have been revoked.
      */
     revokeVerifiableCredentials(controller: string, issuerDocumentId: string, credentialIndices: number[]): Promise<void>;
     /**
      * Unrevoke verifiable credential(s).
      * @param controller The controller of the identity who can make changes.
      * @param issuerDocumentId The id of the document to update the revocation list for.
-     * @param credentialIndices The revocation bitmap index or indices to un revoke.
-     * @returns Nothing.
+     * @param credentialIndices The revocation bitmap index or indices to unrevoke.
+     * @returns A promise that resolves when the credentials have been unrevoked.
      */
     unrevokeVerifiableCredentials(controller: string, issuerDocumentId: string, credentialIndices: number[]): Promise<void>;
     /**
@@ -109,20 +139,31 @@ export interface IIdentityConnector extends IComponent {
      * @param contexts The contexts for the data stored in the verifiable credential.
      * @param types The types for the data stored in the verifiable credential.
      * @param verifiableCredentials The credentials to use for creating the presentation in jwt format.
-     * @param expiresInMinutes The time in minutes for the presentation to expire.
+     * @param options Additional options for creating the verifiable presentation.
+     * @param options.expirationDate The date the verifiable presentation is valid until.
+     * @param options.jwtHeaderFields Additional fields to include in the JWT header when creating the verifiable presentation in jwt format.
+     * @param options.jwtPayloadFields Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format.
      * @returns The created verifiable presentation and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    createVerifiablePresentation(controller: string, verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number): Promise<{
+    createVerifiablePresentation(controller: string, verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], options?: {
+        expirationDate?: Date;
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
+    }): Promise<{
         verifiablePresentation: IDidVerifiablePresentation;
         jwt: string;
     }>;
     /**
      * Check a verifiable presentation is valid.
-     * @param presentationJwt The presentation to verify.
+     * @param presentation The presentation to verify.
      * @returns The presentation stored in the jwt and the revocation status.
      */
-    checkVerifiablePresentation(presentationJwt: string): Promise<{
+    checkVerifiablePresentation(presentation: string | IDidVerifiablePresentation): Promise<{
         revoked: boolean;
         verifiablePresentation?: IDidVerifiablePresentation;
         issuers?: IDidDocument[];

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

@@ -9,7 +9,7 @@ export interface IIdentityProfileComponent<T extends IJsonLdDocument = IJsonLdDo
      * @param publicProfile The public profile data as JSON-LD.
      * @param privateProfile The private profile data as JSON-LD.
      * @param identity The identity to perform the profile operation on.
-     * @returns Nothing.
+     * @returns A promise that resolves when the profile has been created.
      */
     create(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;
     /**
@@ -36,13 +36,13 @@ export interface IIdentityProfileComponent<T extends IJsonLdDocument = IJsonLdDo
      * @param publicProfile The public profile data as JSON-LD.
      * @param privateProfile The private profile data as JSON-LD.
      * @param identity The identity to perform the profile operation on.
-     * @returns Nothing.
+     * @returns A promise that resolves when the profile has been updated.
      */
     update(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;
     /**
      * Delete the profile for an identity.
      * @param identity The identity to perform the profile operation on.
-     * @returns Nothing.
+     * @returns A promise that resolves when the profile has been removed.
      */
     remove(identity?: string): Promise<void>;
     /**

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

@@ -9,7 +9,7 @@ export interface IIdentityProfileConnector<T extends IJsonLdDocument = IJsonLdDo
      * @param identity The identity of the profile to create.
      * @param publicProfile The public profile data as JSON-LD.
      * @param privateProfile The private profile data as JSON-LD.
-     * @returns Nothing.
+     * @returns A promise that resolves when the profile has been created.
      */
     create(identity: string, publicProfile?: T, privateProfile?: U): Promise<void>;
     /**
@@ -28,13 +28,13 @@ export interface IIdentityProfileConnector<T extends IJsonLdDocument = IJsonLdDo
      * @param identity The identity to update.
      * @param publicProfile The public profile data as JSON-LD.
      * @param privateProfile The private profile data as JSON-LD.
-     * @returns Nothing.
+     * @returns A promise that resolves when the profile has been updated.
      */
     update(identity: string, publicProfile?: T, privateProfile?: U): Promise<void>;
     /**
      * Delete the profile for an identity.
      * @param identity The identity to delete.
-     * @returns Nothing.
+     * @returns A promise that resolves when the profile has been removed.
      */
     remove(identity: string): Promise<void>;
     /**

package/dist/types/models/api/identity/IIdentityAlsoKnownAsCreateRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Request to create an alias for an identity.
+ */
+export interface IIdentityAlsoKnownAsCreateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to create the alias for.
+         */
+        identity: string;
+    };
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The alias to create for the identity.
+         */
+        alias: string;
+    };
+}

package/dist/types/models/api/identity/IIdentityAlsoKnownAsRemoveRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Request to remove an alias from an identity.
+ */
+export interface IIdentityAlsoKnownAsRemoveRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to remove the alias from.
+         */
+        identity: string;
+        /**
+         * The alias to remove.
+         */
+        alias: string;
+    };
+}

package/dist/types/models/api/identity/IIdentityVerifiableCredentialCreateRequest.d.ts

@@ -36,5 +36,17 @@ export interface IIdentityVerifiableCredentialCreateRequest {
          * The date the verifiable credential is valid until.
          */
         expirationDate?: string;
+        /**
+         * Additional fields to include in the JWT when creating the verifiable credential in jwt format.
+         */
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        /**
+         * Additional fields to include in the JWT payload when creating the verifiable credential in jwt format.
+         */
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
     };
 }

package/dist/types/models/api/identity/IIdentityVerifiableCredentialVerifyDocumentRequest.d.ts

@@ -0,0 +1,10 @@
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
+/**
+ * Request to verify a verifiable credential.
+ */
+export interface IIdentityVerifiableCredentialVerifyDocumentRequest {
+    /**
+     * The body parameters.
+     */
+    body: IDidVerifiableCredential;
+}

package/dist/types/models/api/identity/IIdentityVerifiablePresentationCreateRequest.d.ts

@@ -38,8 +38,20 @@ export interface IIdentityVerifiablePresentationCreateRequest {
          */
         verifiableCredentials: (string | IDidVerifiableCredential)[];
         /**
-         * The expiration time for the presentation.
+         * The expiration date/time for the presentation.
          */
-        expiresInMinutes?: number;
+        expirationDate?: string;
+        /**
+         * Additional fields to include in the JWT header when creating the verifiable presentation in jwt format.
+         */
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        /**
+         * Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format.
+         */
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
     };
 }

package/dist/types/models/api/identity/IIdentityVerifiablePresentationVerifyDocumentRequest.d.ts

@@ -0,0 +1,10 @@
+import type { IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+/**
+ * Request to verify a verifiable presentation.
+ */
+export interface IIdentityVerifiablePresentationVerifyDocumentRequest {
+    /**
+     * The body parameters.
+     */
+    body: IDidVerifiablePresentation;
+}

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

@@ -0,0 +1,49 @@
+/**
+ * Metric IDs for the identity service.
+ */
+export declare const IdentityMetricIds: {
+    /**
+     * Number of DIDs created.
+     */
+    readonly DidsCreated: "identity_dids_created";
+    /**
+     * Number of DIDs removed.
+     */
+    readonly DidsRemoved: "identity_dids_removed";
+    /**
+     * Number of verifiable credentials created.
+     */
+    readonly VcsCreated: "identity_vcs_created";
+    /**
+     * Number of VC verifications succeeded.
+     */
+    readonly VcsVerified: "identity_vcs_verified";
+    /**
+     * Number of VC verifications failed.
+     */
+    readonly VcsVerificationFailed: "identity_vcs_verification_failed";
+    /**
+     * Number of VCs revoked.
+     */
+    readonly VcsRevoked: "identity_vcs_revoked";
+    /**
+     * Number of VCs unrevoked.
+     */
+    readonly VcsUnrevoked: "identity_vcs_unrevoked";
+    /**
+     * Number of verifiable presentations created.
+     */
+    readonly VpsCreated: "identity_vps_created";
+    /**
+     * Number of VP verifications succeeded.
+     */
+    readonly VpsVerified: "identity_vps_verified";
+    /**
+     * Number of VP verifications failed.
+     */
+    readonly VpsVerificationFailed: "identity_vps_verification_failed";
+};
+/**
+ * Union type of all identity service metric ID string values.
+ */
+export type IdentityMetricIds = (typeof IdentityMetricIds)[keyof typeof IdentityMetricIds];

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

@@ -0,0 +1,5 @@
+import { type ITelemetryMetric } from "@twin.org/telemetry-models";
+/**
+ * Metrics registered by the identity service.
+ */
+export declare const IdentityMetrics: ITelemetryMetric[];

package/dist/types/types/did.d.ts

@@ -1,5 +1,5 @@
 /**
- * Helper methods for Ids.
+ * Helper methods for parsing and validating DID identifiers.
  */
 export declare class Did {
     /**
@@ -7,7 +7,7 @@ export declare class Did {
      */
     static readonly CLASS_NAME: string;
     /**
-     * Parse and id in to it's constituent parts.
+     * Parse an id into its constituent parts.
      * @param id The id to parse.
      * @returns The parsed id.
      * @throws GeneralError if the id is not valid.
@@ -21,7 +21,7 @@ export declare class Did {
      * Guard a string as a DID.
      * @param source The source of the error.
      * @param property The name of the property.
-     * @param value The urn to parse.
+     * @param value The value to assert as a valid DID.
      * @throws GuardError If the value does not match the assertion.
      */
     static guard(source: string, property: string, value: unknown): asserts value is string;

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

@@ -10,20 +10,20 @@ export declare class VerificationHelper {
      */
     static readonly CLASS_NAME: string;
     /**
-     * Verified the JWT.
+     * Verify the JWT and return the decoded header and payload.
      * @param resolver The resolver to use for finding the document.
      * @param jwt The token to verify.
-     * @returns The decoded payload.
+     * @returns The decoded header and 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.
+     * Verify the proof for the document.
      * @param resolver The resolver to use for finding the document.
      * @param secureDocument The secure document to verify.
-     * @returns True if the verification is successful.
+     * @returns True if all proofs in the document are verified successfully.
      */
     static verifyProof(resolver: IIdentityResolverComponent, secureDocument: IJsonLdNodeObject): Promise<boolean>;
 }