feat(revokeClaim): make did param required

energywebfoundation · Jun 24, 2022 · b6648d6 · b6648d6
1 parent 80cf934
commit b6648d6
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 17 deletions.
diff --git a/docs/api/classes/modules_cache_client.CacheClient.md b/docs/api/classes/modules_cache_client.CacheClient.md
@@ -374,12 +374,13 @@ ___
 
 ### getClaimsByRevoker
 
-▸ **getClaimsByRevoker**(`__namedParameters?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\>
+▸ **getClaimsByRevoker**(`revoker`, `__namedParameters?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
+| `revoker` | `string` |
 | `__namedParameters` | [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter) |
 
 #### Returns

diff --git a/docs/api/classes/modules_claims.ClaimsService.md b/docs/api/classes/modules_claims.ClaimsService.md
@@ -338,21 +338,22 @@ ___
 
 ### getClaimsByRevoker
 
-▸ **getClaimsByRevoker**(`options?`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\>
+▸ **getClaimsByRevoker**(`options`): `Promise`<[`Claim`](../interfaces/modules_claims.Claim.md)[]\>
 
 Retrieve all claims that a user can revoke. Allow to filter by namespace
 
 ```typescript
 claimsService.getClaimsByRevoker({
- namespace?: 'energyweb.iam.ewc'
+ did: 'did:ethr:0x00...0',
+ namespace: 'energyweb.iam.ewc',
 });
 ```
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `options?` | [`GetClaimsByRevokerOptions`](../interfaces/modules_claims.GetClaimsByRevokerOptions.md) |
+| `options` | [`GetClaimsByRevokerOptions`](../interfaces/modules_claims.GetClaimsByRevokerOptions.md) |
 
 #### Returns
 

diff --git a/docs/api/interfaces/modules_cache_client.ICacheClient.md b/docs/api/interfaces/modules_cache_client.ICacheClient.md
@@ -238,12 +238,13 @@ ___
 
 ### getClaimsByRevoker
 
-▸ **getClaimsByRevoker**(`filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\>
+▸ **getClaimsByRevoker**(`revoker`, `filter?`): `Promise`<[`Claim`](modules_claims.Claim.md)[]\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
+| `revoker` | `string` |
 | `filter?` | [`ClaimsFilter`](../modules/modules_cache_client.md#claimsfilter) |
 
 #### Returns

diff --git a/docs/api/interfaces/modules_claims.GetClaimsByRevokerOptions.md b/docs/api/interfaces/modules_claims.GetClaimsByRevokerOptions.md
@@ -6,10 +6,19 @@
 
 ### Properties
 
+- [did](modules_claims.GetClaimsByRevokerOptions.md#did)
 - [namespace](modules_claims.GetClaimsByRevokerOptions.md#namespace)
 
 ## Properties
 
+### did
+
+• **did**: `string`
+
+DID of the subject
+
+___
+
 ### namespace
 
 • `Optional` **namespace**: `string`

diff --git a/src/modules/cache-client/cache-client.interface.ts b/src/modules/cache-client/cache-client.interface.ts
@@ -60,7 +60,10 @@ export interface ICacheClient {
     filter?: ClaimsFilter
   ) => Promise<Claim[]>;
   getClaimById: (claimId: string) => Promise<Claim | undefined>;
-  getClaimsByRevoker: (filter?: ClaimsFilter) => Promise<Claim[]>;
+  getClaimsByRevoker: (
+    revoker: string,
+    filter?: ClaimsFilter
+  ) => Promise<Claim[]>;
   requestClaim: (message: IClaimRequest) => Promise<void>;
   issueClaim: (issuer: string, message: IClaimIssuance) => Promise<void>;
   rejectClaim: (issuer: string, message: IClaimRejection) => Promise<void>;

diff --git a/src/modules/cache-client/cache-client.service.ts b/src/modules/cache-client/cache-client.service.ts
@@ -347,12 +347,15 @@ export class CacheClient implements ICacheClient {
     return data;
   }
 
-  async getClaimsByRevoker({ namespace }: ClaimsFilter = {}) {
-    const { data } = await this._httpClient.get<Claim[]>(`/claim/revoker`, {
-      params: {
-        namespace,
-      },
-    });
+  async getClaimsByRevoker(revoker: string, { namespace }: ClaimsFilter = {}) {
+    const { data } = await this._httpClient.get<Claim[]>(
+      `/claim/revoker/${revoker}`,
+      {
+        params: {
+          namespace,
+        },
+      }
+    );
     return data;
   }
 

diff --git a/src/modules/claims/claims.service.ts b/src/modules/claims/claims.service.ts
@@ -272,17 +272,19 @@ export class ClaimsService {
    *
    * ```typescript
    * claimsService.getClaimsByRevoker({
-   *  namespace?: 'energyweb.iam.ewc'
+   *  did: 'did:ethr:0x00...0',
+   *  namespace: 'energyweb.iam.ewc',
    * });
    * ```
    *
    * @param {GetClaimsByRevokerOptions} options
    * @return list of claims
    */
-  async getClaimsByRevoker(
-    options?: GetClaimsByRevokerOptions
-  ): Promise<Claim[]> {
-    return this._cacheClient.getClaimsByRevoker(options);
+  async getClaimsByRevoker({
+    did,
+    namespace,
+  }: GetClaimsByRevokerOptions): Promise<Claim[]> {
+    return this._cacheClient.getClaimsByRevoker(did, { namespace });
   }
 
   /**

diff --git a/src/modules/claims/claims.types.ts b/src/modules/claims/claims.types.ts
@@ -139,6 +139,9 @@ export interface GetClaimsBySubjectOptions {
 }
 
 export interface GetClaimsByRevokerOptions {
+  /** DID of the subject */
+  did: string;
+
   /** Indicates what namespace `Claims` should be in */
   namespace?: string;
 }