@twin.org/identity-connector-entity-storage 0.0.3-next.2 → 0.0.3-next.21

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.
@@ -76,6 +76,28 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @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 Nothing.
+     * @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 Nothing.
+     * @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.
@@ -97,12 +119,12 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
     }>;
     /**
      * 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).
@@ -128,31 +150,38 @@ 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.
      * @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;
+    }): 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>;
     /**