@twin.org/identity-connector-entity-storage 0.0.3-next.9 → 0.9.0

package/dist/es/entityStorageIdentityResolverConnector.js.map

@@ -1 +1 @@
-{"version":3,"file":"entityStorageIdentityResolverConnector.js","sourceRoot":"","sources":["../../src/entityStorageIdentityResolverConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EACN,6BAA6B,EAE7B,MAAM,iCAAiC,CAAC;AAIzC,OAAO,EAAE,qBAAqB,EAAwB,MAAM,wBAAwB,CAAC;AAErF,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAGrF;;GAEG;AACH,MAAM,OAAO,sCAAsC;IAClD;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,gBAAgB,CAAC;IAE5D;;OAEG;IACI,MAAM,CAAU,UAAU,4CAA4D;IAE7F;;;OAGG;IACgB,yBAAyB,CAA4C;IAExF;;;OAGG;IACgB,eAAe,CAAkB;IAEpD;;;OAGG;IACH,YAAY,OAAmE;QAC9E,IAAI,CAAC,yBAAyB,GAAG,6BAA6B,CAAC,GAAG,CACjE,OAAO,EAAE,4BAA4B,IAAI,mBAAmB,CAC5D,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,EAAE,kBAAkB,IAAI,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,sCAAsC,CAAC,UAAU,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAAC,UAAkB;QAC9C,MAAM,CAAC,WAAW,CACjB,sCAAsC,CAAC,UAAU,gBAEjD,UAAU,CACV,CAAC;QAEF,IAAI,CAAC;YACJ,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACjF,IAAI,EAAE,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBACvC,MAAM,IAAI,aAAa,CACtB,sCAAsC,CAAC,UAAU,EACjD,kBAAkB,EAClB,UAAU,CACV,CAAC;YACH,CAAC;YACD,MAAM,8BAA8B,CAAC,cAAc,CAClD,mBAAmB,EACnB,IAAI,CAAC,eAAe,CACpB,CAAC;YAEF,OAAO,mBAAmB,CAAC,QAAQ,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,sCAAsC,CAAC,UAAU,EACjD,uBAAuB,EACvB,SAAS,EACT,KAAK,CACL,CAAC;QACH,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is, NotFoundError } from \"@twin.org/core\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport type { IIdentityResolverConnector } from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IDidDocument } from \"@twin.org/standards-w3c-did\";\nimport { VaultConnectorFactory, type IVaultConnector } from \"@twin.org/vault-models\";\nimport type { IdentityDocument } from \"./entities/identityDocument.js\";\nimport { EntityStorageIdentityConnector } from \"./entityStorageIdentityConnector.js\";\nimport type { IEntityStorageIdentityResolverConnectorConstructorOptions } from \"./models/IEntityStorageIdentityResolverConnectorConstructorOptions.js\";\n\n/**\n * Class for performing identity operations using entity storage.\n */\nexport class EntityStorageIdentityResolverConnector implements IIdentityResolverConnector {\n\t/**\n\t * The namespace supported by the identity connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"entity-storage\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<EntityStorageIdentityResolverConnector>();\n\n\t/**\n\t * The entity storage for identities.\n\t * @internal\n\t */\n\tprotected readonly _didDocumentEntityStorage: IEntityStorageConnector<IdentityDocument>;\n\n\t/**\n\t * The vault for the keys.\n\t * @internal\n\t */\n\tprotected readonly _vaultConnector: IVaultConnector;\n\n\t/**\n\t * Create a new instance of EntityStorageIdentityResolverConnector.\n\t * @param options The options for the identity connector.\n\t */\n\tconstructor(options?: IEntityStorageIdentityResolverConnectorConstructorOptions) {\n\t\tthis._didDocumentEntityStorage = EntityStorageConnectorFactory.get(\n\t\t\toptions?.didDocumentEntityStorageType ?? \"identity-document\"\n\t\t);\n\t\tthis._vaultConnector = VaultConnectorFactory.get(options?.vaultConnectorType ?? \"vault\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn EntityStorageIdentityResolverConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Resolve a document from its id.\n\t * @param documentId The id of the document to resolve.\n\t * @returns The resolved document.\n\t * @throws NotFoundError if the id can not be resolved.\n\t */\n\tpublic async resolveDocument(documentId: string): Promise<IDidDocument> {\n\t\tGuards.stringValue(\n\t\t\tEntityStorageIdentityResolverConnector.CLASS_NAME,\n\t\t\tnameof(documentId),\n\t\t\tdocumentId\n\t\t);\n\n\t\ttry {\n\t\t\tconst didIdentityDocument = await this._didDocumentEntityStorage.get(documentId);\n\t\t\tif (Is.undefined(didIdentityDocument)) {\n\t\t\t\tthrow new NotFoundError(\n\t\t\t\t\tEntityStorageIdentityResolverConnector.CLASS_NAME,\n\t\t\t\t\t\"documentNotFound\",\n\t\t\t\t\tdocumentId\n\t\t\t\t);\n\t\t\t}\n\t\t\tawait EntityStorageIdentityConnector.verifyDocument(\n\t\t\t\tdidIdentityDocument,\n\t\t\t\tthis._vaultConnector\n\t\t\t);\n\n\t\t\treturn didIdentityDocument.document;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tEntityStorageIdentityResolverConnector.CLASS_NAME,\n\t\t\t\t\"resolveDocumentFailed\",\n\t\t\t\tundefined,\n\t\t\t\terror\n\t\t\t);\n\t\t}\n\t}\n}\n"]}
+{"version":3,"file":"entityStorageIdentityResolverConnector.js","sourceRoot":"","sources":["../../src/entityStorageIdentityResolverConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EACN,6BAA6B,EAE7B,MAAM,iCAAiC,CAAC;AAIzC,OAAO,EAAE,qBAAqB,EAAwB,MAAM,wBAAwB,CAAC;AAErF,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAGrF;;GAEG;AACH,MAAM,OAAO,sCAAsC;IAClD;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,gBAAgB,CAAC;IAE5D;;OAEG;IACI,MAAM,CAAU,UAAU,4CAA4D;IAE7F;;;OAGG;IACgB,yBAAyB,CAA4C;IAExF;;;OAGG;IACgB,eAAe,CAAkB;IAEpD;;;OAGG;IACH,YAAY,OAAmE;QAC9E,IAAI,CAAC,yBAAyB,GAAG,6BAA6B,CAAC,GAAG,CACjE,OAAO,EAAE,4BAA4B,IAAI,mBAAmB,CAC5D,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,qBAAqB,CAAC,GAAG,CAAC,OAAO,EAAE,kBAAkB,IAAI,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,sCAAsC,CAAC,UAAU,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAAC,UAAkB;QAC9C,MAAM,CAAC,WAAW,CACjB,sCAAsC,CAAC,UAAU,gBAEjD,UAAU,CACV,CAAC;QAEF,IAAI,CAAC;YACJ,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACjF,IAAI,EAAE,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBACvC,MAAM,IAAI,aAAa,CACtB,sCAAsC,CAAC,UAAU,EACjD,kBAAkB,EAClB,UAAU,CACV,CAAC;YACH,CAAC;YACD,MAAM,8BAA8B,CAAC,cAAc,CAClD,mBAAmB,EACnB,IAAI,CAAC,eAAe,CACpB,CAAC;YAEF,OAAO,mBAAmB,CAAC,QAAQ,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CACrB,sCAAsC,CAAC,UAAU,EACjD,uBAAuB,EACvB,EAAE,UAAU,EAAE,EACd,KAAK,CACL,CAAC;QACH,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is, NotFoundError } from \"@twin.org/core\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport type { IIdentityResolverConnector } from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IDidDocument } from \"@twin.org/standards-w3c-did\";\nimport { VaultConnectorFactory, type IVaultConnector } from \"@twin.org/vault-models\";\nimport type { IdentityDocument } from \"./entities/identityDocument.js\";\nimport { EntityStorageIdentityConnector } from \"./entityStorageIdentityConnector.js\";\nimport type { IEntityStorageIdentityResolverConnectorConstructorOptions } from \"./models/IEntityStorageIdentityResolverConnectorConstructorOptions.js\";\n\n/**\n * Class for performing identity operations using entity storage.\n */\nexport class EntityStorageIdentityResolverConnector implements IIdentityResolverConnector {\n\t/**\n\t * The namespace supported by the identity connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"entity-storage\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<EntityStorageIdentityResolverConnector>();\n\n\t/**\n\t * The entity storage for identities.\n\t * @internal\n\t */\n\tprotected readonly _didDocumentEntityStorage: IEntityStorageConnector<IdentityDocument>;\n\n\t/**\n\t * The vault for the keys.\n\t * @internal\n\t */\n\tprotected readonly _vaultConnector: IVaultConnector;\n\n\t/**\n\t * Create a new instance of EntityStorageIdentityResolverConnector.\n\t * @param options The options for the identity connector.\n\t */\n\tconstructor(options?: IEntityStorageIdentityResolverConnectorConstructorOptions) {\n\t\tthis._didDocumentEntityStorage = EntityStorageConnectorFactory.get(\n\t\t\toptions?.didDocumentEntityStorageType ?? \"identity-document\"\n\t\t);\n\t\tthis._vaultConnector = VaultConnectorFactory.get(options?.vaultConnectorType ?? \"vault\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn EntityStorageIdentityResolverConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Resolve a document from its id.\n\t * @param documentId The id of the document to resolve.\n\t * @returns The resolved document.\n\t * @throws NotFoundError if the id can not be resolved.\n\t */\n\tpublic async resolveDocument(documentId: string): Promise<IDidDocument> {\n\t\tGuards.stringValue(\n\t\t\tEntityStorageIdentityResolverConnector.CLASS_NAME,\n\t\t\tnameof(documentId),\n\t\t\tdocumentId\n\t\t);\n\n\t\ttry {\n\t\t\tconst didIdentityDocument = await this._didDocumentEntityStorage.get(documentId);\n\t\t\tif (Is.undefined(didIdentityDocument)) {\n\t\t\t\tthrow new NotFoundError(\n\t\t\t\t\tEntityStorageIdentityResolverConnector.CLASS_NAME,\n\t\t\t\t\t\"documentNotFound\",\n\t\t\t\t\tdocumentId\n\t\t\t\t);\n\t\t\t}\n\t\t\tawait EntityStorageIdentityConnector.verifyDocument(\n\t\t\t\tdidIdentityDocument,\n\t\t\t\tthis._vaultConnector\n\t\t\t);\n\n\t\t\treturn didIdentityDocument.document;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tEntityStorageIdentityResolverConnector.CLASS_NAME,\n\t\t\t\t\"resolveDocumentFailed\",\n\t\t\t\t{ documentId },\n\t\t\t\terror\n\t\t\t);\n\t\t}\n\t}\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"IEntityStorageIdentityConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageIdentityConnectorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEntityStorageIdentityResolverConnectorConstructorOptions } from \"./IEntityStorageIdentityResolverConnectorConstructorOptions.js\";\n\n/**\n * Options for the entity storage identity connector constructor.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface IEntityStorageIdentityConnectorConstructorOptions\n\textends IEntityStorageIdentityResolverConnectorConstructorOptions {}\n"]}
+{"version":3,"file":"IEntityStorageIdentityConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IEntityStorageIdentityConnectorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEntityStorageIdentityResolverConnectorConstructorOptions } from \"./IEntityStorageIdentityResolverConnectorConstructorOptions.js\";\n\n/**\n * Options for the entity storage identity connector constructor.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface, max-len\nexport interface IEntityStorageIdentityConnectorConstructorOptions extends IEntityStorageIdentityResolverConnectorConstructorOptions {}\n"]}

package/dist/types/entityStorageIdentityConnector.d.ts

@@ -1,6 +1,6 @@
 import { type IJsonLdContextDefinitionRoot, type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IIdentityConnector } from "@twin.org/identity-models";
-import { DidVerificationMethodType, ProofTypes, type IDidDocument, type IDidDocumentVerificationMethod, type IDidService, type IDidVerifiableCredentialV1, type IDidVerifiablePresentationV1, type IProof } from "@twin.org/standards-w3c-did";
+import { DidVerificationMethodType, type IDidVerifiableCredential, ProofTypes, type IDidDocument, type IDidDocumentVerificationMethod, type IDidService, type IDidVerifiableCredentialV1, type IDidVerifiablePresentationV1, type IProof, type IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
 import type { IEntityStorageIdentityConnectorConstructorOptions } from "./models/IEntityStorageIdentityConnectorConstructorOptions.js";
 /**
  * Class for performing identity operations using entity storage.
@@ -34,7 +34,7 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * 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>;
     /**
@@ -52,7 +52,7 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * 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.
      */
@@ -72,10 +72,32 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * 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.
@@ -85,31 +107,39 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @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 add to the JWT header.
+     * @param options.jwtPayloadFields Additional fields to add to the JWT payload.
      * @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: IDidVerifiableCredentialV1;
         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?: IDidVerifiableCredentialV1;
+        verifiableCredential?: IDidVerifiableCredential;
     }>;
     /**
      * Revoke 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 revoke.
-     * @returns Nothing.
+     * @returns A promise that resolves when the credentials have been revoked.
      */
     revokeVerifiableCredentials(controller: string, issuerDocumentId: string, credentialIndices: number[]): Promise<void>;
     /**
@@ -117,7 +147,7 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @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.
+     * @returns A promise that resolves when the credentials have been unrevoked.
      */
     unrevokeVerifiableCredentials(controller: string, issuerDocumentId: string, credentialIndices: number[]): Promise<void>;
     /**
@@ -128,31 +158,46 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @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 add to the JWT header.
+     * @param options.jwtPayloadFields Additional fields to add to the JWT payload.
      * @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 | IDidVerifiableCredentialV1)[], expiresInMinutes?: number): Promise<{
+    createVerifiablePresentation(controller: string, verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredentialV1)[], options?: {
+        expirationDate?: Date;
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
+    }): Promise<{
         verifiablePresentation: IDidVerifiablePresentationV1;
         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?: IDidVerifiablePresentationV1;
         issuers?: IDidDocument[];
     }>;
     /**
      * Create a proof for arbitrary data with the specified verification method.
+     * This method uses async signing to ensure the private key never leaves the vault,
+     * with algorithm validation to ensure key type compatibility.
      * @param controller The controller of the identity who can make changes.
      * @param verificationMethodId The verification method id to use.
      * @param proofType The type of proof to create.
      * @param unsecureDocument The unsecure document to create the proof for.
      * @returns The proof.
+     * @throws NotFoundError if the identity or method is not found.
+     * @throws GeneralError if algorithm doesn't match key type or proof creation fails.
      */
     createProof(controller: string, verificationMethodId: string, proofType: ProofTypes, unsecureDocument: IJsonLdNodeObject): Promise<IProof>;
     /**

package/dist/types/entityStorageIdentityProfileConnector.d.ts

@@ -28,7 +28,7 @@ export declare class EntityStorageIdentityProfileConnector<T extends IJsonLdDocu
      * @param identity The identity of the profile to create.
      * @param publicProfile The public profile data.
      * @param privateProfile The private profile data.
-     * @returns Nothing.
+     * @returns A promise that resolves when the profile has been created.
      */
     create(identity: string, publicProfile?: T, privateProfile?: U): Promise<void>;
     /**
@@ -47,13 +47,13 @@ export declare class EntityStorageIdentityProfileConnector<T extends IJsonLdDocu
      * @param identity The identity to update.
      * @param publicProfile The public profile data.
      * @param privateProfile The private profile data.
-     * @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>;
     /**