feat: add method to get claims by revoker to cache client interface

energywebfoundation · Jun 20, 2022 · e24b506 · e24b506
1 parent 55ff5b2
commit e24b506
Show file tree

Hide file tree

Showing 7 changed files with 88 additions and 402 deletions.
diff --git a/docs/api/classes/modules_cache_client.CacheClient.md b/docs/api/classes/modules_cache_client.CacheClient.md
@@ -50,6 +50,7 @@
 - [getPreviouslyOwnedAssets](modules_cache_client.CacheClient.md#getpreviouslyownedassets)
 - [getRoleDefinition](modules_cache_client.CacheClient.md#getroledefinition)
 - [getRolesByOwner](modules_cache_client.CacheClient.md#getrolesbyowner)
+- [getRolesByRevoker](modules_cache_client.CacheClient.md#getrolesbyrevoker)
 - [getRolesDefinition](modules_cache_client.CacheClient.md#getrolesdefinition)
 - [getStatusListCredential](modules_cache_client.CacheClient.md#getstatuslistcredential)
 - [getSubOrganizationsByOrganization](modules_cache_client.CacheClient.md#getsuborganizationsbyorganization)
@@ -654,6 +655,26 @@ ___
 
 ___
 
+### getRolesByRevoker
+
+▸ **getRolesByRevoker**(`revoker`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `revoker` | `string` |
+
+#### Returns
+
+`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\>
+
+#### Implementation of
+
+[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[getRolesByRevoker](../interfaces/modules_cache_client.ICacheClient.md#getrolesbyrevoker)
+
+___
+
 ### getRolesDefinition
 
 ▸ **getRolesDefinition**(`namespaces`): `Promise`<`Record`<`string`, `IRoleDefinition`\>\>

diff --git a/docs/api/classes/modules_domains.DomainsService.md b/docs/api/classes/modules_domains.DomainsService.md
@@ -30,6 +30,7 @@ domainsService.createOrganization(...);
 - [deleteOrganization](modules_domains.DomainsService.md#deleteorganization)
 - [deleteRole](modules_domains.DomainsService.md#deleterole)
 - [getAllowedRolesByIssuer](modules_domains.DomainsService.md#getallowedrolesbyissuer)
+- [getAllowedRolesByRevoker](modules_domains.DomainsService.md#getallowedrolesbyrevoker)
 - [getAppsOfOrg](modules_domains.DomainsService.md#getappsoforg)
 - [getDIDsByRole](modules_domains.DomainsService.md#getdidsbyrole)
 - [getDefinition](modules_domains.DomainsService.md#getdefinition)
@@ -378,6 +379,30 @@ array of roles that the DID can issue
 
 ___
 
+### getAllowedRolesByRevoker
+
+▸ **getAllowedRolesByRevoker**(`did`): `Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\>
+
+Get all roles that a DID can revoke.
+
+```typescript
+domainsService.getAllowedRolesByRevoker('did:ethr:0x00...0');
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `did` | `string` | issuer DID |
+
+#### Returns
+
+`Promise`<[`IRole`](../interfaces/modules_domains.IRole.md)[]\>
+
+array of roles that the DID can issue
+
+___
+
 ### getAppsOfOrg
 
 ▸ **getAppsOfOrg**(`org`): `Promise`<[`IApp`](../interfaces/modules_domains.IApp.md)[]\>

diff --git a/docs/api/interfaces/modules_cache_client.ICacheClient.md b/docs/api/interfaces/modules_cache_client.ICacheClient.md
@@ -39,6 +39,7 @@
 - [getPreviouslyOwnedAssets](modules_cache_client.ICacheClient.md#getpreviouslyownedassets)
 - [getRoleDefinition](modules_cache_client.ICacheClient.md#getroledefinition)
 - [getRolesByOwner](modules_cache_client.ICacheClient.md#getrolesbyowner)
+- [getRolesByRevoker](modules_cache_client.ICacheClient.md#getrolesbyrevoker)
 - [getRolesDefinition](modules_cache_client.ICacheClient.md#getrolesdefinition)
 - [getSubOrganizationsByOrganization](modules_cache_client.ICacheClient.md#getsuborganizationsbyorganization)
 - [isAuthEnabled](modules_cache_client.ICacheClient.md#isauthenabled)
@@ -462,6 +463,22 @@ ___
 
 ___
 
+### getRolesByRevoker
+
+▸ **getRolesByRevoker**(`revoker`): `Promise`<[`IRole`](modules_domains.IRole.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `revoker` | `string` |
+
+#### Returns
+
+`Promise`<[`IRole`](modules_domains.IRole.md)[]\>
+
+___
+
 ### getRolesDefinition
 
 ▸ **getRolesDefinition**(`namespace`): `Promise`<`Record`<`string`, `IRoleDefinition`\>\>