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

package/dist/types/identityRestClient.d.ts

@@ -30,7 +30,7 @@ export declare class IdentityRestClient extends BaseRestClient implements IIdent
     /**
      * Remove an identity.
      * @param identity The id of the document to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the identity has been removed.
      */
     identityRemove(identity: string): Promise<void>;
     /**
@@ -46,7 +46,7 @@ export declare class IdentityRestClient extends BaseRestClient implements IIdent
     /**
      * Remove a verification method from the document.
      * @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.
      */
@@ -64,10 +64,30 @@ export declare class IdentityRestClient extends BaseRestClient implements IIdent
     /**
      * Remove a service from the document.
      * @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.
      */
     serviceRemove(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 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.
+     */
+    alsoKnownAsAdd(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 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.
+     */
+    alsoKnownAsRemove(documentId: string, alias: string): Promise<void>;
     /**
      * Create a verifiable credential for a verification method.
      * @param verificationMethodId The verification method id to use.
@@ -76,37 +96,45 @@ export declare class IdentityRestClient extends BaseRestClient implements IIdent
      * @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.
      */
     verifiableCredentialCreate(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;
     }>;
     /**
      * 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.
-     * @returns Nothing.
+     * @param credentialIndex The revocation bitmap index to revoke.
+     * @returns A promise that resolves when the credential has been revoked.
      */
     verifiableCredentialRevoke(issuerId: string, credentialIndex: number): 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.
-     * @returns Nothing.
+     * @param credentialIndex The revocation bitmap index to unrevoke.
+     * @returns A promise that resolves when the credential has been unrevoked.
      */
     verifiableCredentialUnrevoke(issuerId: string, credentialIndex: number): Promise<void>;
     /**
@@ -116,20 +144,31 @@ export declare class IdentityRestClient extends BaseRestClient implements IIdent
      * @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.
      */
-    verifiablePresentationCreate(verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number): 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;
+        };
+    }): 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[];