fix(domain): fix domain service interfaces

energywebfoundation · May 24, 2022 · 50a014e · 50a014e
1 parent 7b1e457
commit 50a014e
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 24 deletions.
diff --git a/.../api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md b/.../api/classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md
@@ -22,6 +22,7 @@ verifiableCredentialsService.createRoleVC(...);
 - [createPresentation](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createpresentation)
 - [createRoleVC](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createrolevc)
 - [createVerifiablePresentation](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#createverifiablepresentation)
+- [getCredentialsByDefinition](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#getcredentialsbydefinition)
 - [initiateExchange](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#initiateexchange)
 - [verify](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#verify)
 - [create](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md#create)
@@ -30,13 +31,14 @@ verifiableCredentialsService.createRoleVC(...);
 
 ### constructor
 
-• **new VerifiableCredentialsServiceBase**(`_signerService`)
+• **new VerifiableCredentialsServiceBase**(`_signerService`, `_cacheClient`)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `_signerService` | [`SignerService`](modules_signer.SignerService.md) |
+| `_cacheClient` | [`CacheClient`](modules_cache_client.CacheClient.md) |
 
 ## Methods
 
@@ -127,6 +129,26 @@ verifiable presentation
 
 ___
 
+### getCredentialsByDefinition
+
+▸ **getCredentialsByDefinition**(`presentationDefinition`): `Promise`<`SelectResults`\>
+
+Returns issued role verifiable credentials which matches definition
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `presentationDefinition` | `IPresentationDefinition` | credential requirements |
+
+#### Returns
+
+`Promise`<`SelectResults`\>
+
+results of matching each role verifiable credential to definition
+
+___
+
 ### initiateExchange
 
 ▸ **initiateExchange**(`options`): `Promise`<`ContinueExchangeSelections`\>
@@ -188,13 +210,14 @@ ___
 
 ### create
 
-▸ `Static` **create**(`signerService`): `Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\>
+▸ `Static` **create**(`signerService`, `claimsService`): `Promise`<[`VerifiableCredentialsServiceBase`](modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `signerService` | [`SignerService`](modules_signer.SignerService.md) |
+| `claimsService` | [`CacheClient`](modules_cache_client.CacheClient.md) |
 
 #### Returns
 

diff --git a/docs/api/interfaces/modules_domains.DeleteApplicationOptions.md b/docs/api/interfaces/modules_domains.DeleteApplicationOptions.md
@@ -21,6 +21,6 @@ ___
 
 ### returnSteps
 
-• **returnSteps**: `string`
+• `Optional` **returnSteps**: `boolean`
 
 Indicates whether to run steps immediately (false) or return steps that can be executed later (true)
diff --git a/docs/api/interfaces/modules_domains.DeleteOrganizationOptions.md b/docs/api/interfaces/modules_domains.DeleteOrganizationOptions.md
@@ -21,6 +21,6 @@ ___
 
 ### returnSteps
 
-• **returnSteps**: `string`
+• `Optional` **returnSteps**: `boolean`
 
 Indicates whether to run steps immediately (false) or return steps that can be executed later (true)
diff --git a/docs/api/interfaces/modules_verifiable_credentials.InitiateExchangeResults.md b/docs/api/interfaces/modules_verifiable_credentials.InitiateExchangeResults.md
@@ -13,7 +13,7 @@
 
 ### presentationDefinition
 
-• **presentationDefinition**: `PresentationDefinition`
+• **presentationDefinition**: `IPresentationDefinition`
 
 ___
 

diff --git a/docs/api/modules/init.md b/docs/api/modules/init.md
diff --git a/docs/api/modules/modules_verifiable_credentials.md b/docs/api/modules/modules_verifiable_credentials.md
@@ -85,13 +85,14 @@ ___
 
 ### getVerifiableCredentialsService
 
-▸ **getVerifiableCredentialsService**(`signerService`): `Promise`<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\>
+▸ **getVerifiableCredentialsService**(`signerService`, `cacheClient`): `Promise`<[`VerifiableCredentialsServiceBase`](../classes/modules_verifiable_credentials.VerifiableCredentialsServiceBase.md)\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `signerService` | [`SignerService`](../classes/modules_signer.SignerService.md) |
+| `cacheClient` | [`CacheClient`](../classes/modules_cache_client.CacheClient.md) |
 
 #### Returns
 

diff --git a/src/modules/domains/domains.service.ts b/src/modules/domains/domains.service.ts
@@ -621,7 +621,7 @@ export class DomainsService {
    */
   async deleteOrganization({
     namespace,
-    returnSteps,
+    returnSteps = false,
   }: DeleteOrganizationOptions): Promise<
     ReturnStepWithRetryCheck[] | undefined
   > {
@@ -705,7 +705,7 @@ export class DomainsService {
    */
   async deleteApplication({
     namespace,
-    returnSteps,
+    returnSteps = false,
   }: DeleteApplicationOptions): Promise<
     ReturnStepWithRetryCheck[] | undefined
   > {

diff --git a/src/modules/domains/domains.types.ts b/src/modules/domains/domains.types.ts
@@ -174,15 +174,15 @@ export interface DeleteOrganizationOptions {
   namespace: string;
 
   /** Indicates whether to run steps immediately (false) or return steps that can be executed later (true) */
-  returnSteps: string;
+  returnSteps?: boolean;
 }
 
 export interface DeleteApplicationOptions {
   /** Application domain */
   namespace: string;
 
   /** Indicates whether to run steps immediately (false) or return steps that can be executed later (true) */
-  returnSteps: string;
+  returnSteps?: boolean;
 }
 
 export interface DeleteRoleOptions {