feat(claims): new getClaimById method

energywebfoundation · Dec 1, 2021 · 4fddb22 · 4fddb22
1 parent 7fea051
commit 4fddb22
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 0 deletions.
diff --git a/docs/api/classes/modules_cacheClient_cacheClient_service.CacheClient.md b/docs/api/classes/modules_cacheClient_cacheClient_service.CacheClient.md
@@ -28,6 +28,7 @@
 - [getApplicationsByOwner](modules_cacheClient_cacheClient_service.CacheClient.md#getapplicationsbyowner)
 - [getAssetById](modules_cacheClient_cacheClient_service.CacheClient.md#getassetbyid)
 - [getAssetHistory](modules_cacheClient_cacheClient_service.CacheClient.md#getassethistory)
+- [getClaimById](modules_cacheClient_cacheClient_service.CacheClient.md#getclaimbyid)
 - [getClaimsByIssuer](modules_cacheClient_cacheClient_service.CacheClient.md#getclaimsbyissuer)
 - [getClaimsByRequester](modules_cacheClient_cacheClient_service.CacheClient.md#getclaimsbyrequester)
 - [getClaimsBySubject](modules_cacheClient_cacheClient_service.CacheClient.md#getclaimsbysubject)
@@ -269,6 +270,26 @@ ___
 
 ___
 
+### getClaimById
+
+▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims_claims_types.Claim.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `claimId` | `string` |
+
+#### Returns
+
+`Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims_claims_types.Claim.md)\>
+
+#### Implementation of
+
+[ICacheClient](../interfaces/modules_cacheClient_ICacheClient.ICacheClient.md).[getClaimById](../interfaces/modules_cacheClient_ICacheClient.ICacheClient.md#getclaimbyid)
+
+___
+
 ### getClaimsByIssuer
 
 ▸ **getClaimsByIssuer**(`issuer`, `__namedParameters?`): `Promise`<[`Claim`](../interfaces/modules_claims_claims_types.Claim.md)[]\>

diff --git a/docs/api/classes/modules_claims_claims_service.ClaimsService.md b/docs/api/classes/modules_claims_claims_service.ClaimsService.md
@@ -15,6 +15,7 @@
 - [createIdentityProof](modules_claims_claims_service.ClaimsService.md#createidentityproof)
 - [createSelfSignedClaim](modules_claims_claims_service.ClaimsService.md#createselfsignedclaim)
 - [deleteClaim](modules_claims_claims_service.ClaimsService.md#deleteclaim)
+- [getClaimById](modules_claims_claims_service.ClaimsService.md#getclaimbyid)
 - [getClaimId](modules_claims_claims_service.ClaimsService.md#getclaimid)
 - [getClaimsByIssuer](modules_claims_claims_service.ClaimsService.md#getclaimsbyissuer)
 - [getClaimsByRequester](modules_claims_claims_service.ClaimsService.md#getclaimsbyrequester)
@@ -49,6 +50,8 @@
 
 ▸ **createClaimRequest**(`__namedParameters`): `Promise`<`void`\>
 
+**`description`** allows subject to request for credential
+
 #### Parameters
 
 | Name | Type |
@@ -143,6 +146,24 @@ ___
 
 ___
 
+### getClaimById
+
+▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims_claims_types.Claim.md)\>
+
+**`description`** - Returns claim with the given Id or null if claim does not exist
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `claimId` | `string` |
+
+#### Returns
+
+`Promise`<`undefined` \| [`Claim`](../interfaces/modules_claims_claims_types.Claim.md)\>
+
+___
+
 ### getClaimId
 
 ▸ **getClaimId**(`__namedParameters`): `Promise`<`string`\>

diff --git a/docs/api/interfaces/modules_cacheClient_ICacheClient.ICacheClient.md b/docs/api/interfaces/modules_cacheClient_ICacheClient.ICacheClient.md
@@ -22,6 +22,7 @@
 - [getApplicationsByOwner](modules_cacheClient_ICacheClient.ICacheClient.md#getapplicationsbyowner)
 - [getAssetById](modules_cacheClient_ICacheClient.ICacheClient.md#getassetbyid)
 - [getAssetHistory](modules_cacheClient_ICacheClient.ICacheClient.md#getassethistory)
+- [getClaimById](modules_cacheClient_ICacheClient.ICacheClient.md#getclaimbyid)
 - [getClaimsByIssuer](modules_cacheClient_ICacheClient.ICacheClient.md#getclaimsbyissuer)
 - [getClaimsByRequester](modules_cacheClient_ICacheClient.ICacheClient.md#getclaimsbyrequester)
 - [getClaimsBySubject](modules_cacheClient_ICacheClient.ICacheClient.md#getclaimsbysubject)
@@ -183,6 +184,22 @@ ___
 
 ___
 
+### getClaimById
+
+▸ **getClaimById**(`claimId`): `Promise`<`undefined` \| [`Claim`](modules_claims_claims_types.Claim.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `claimId` | `string` |
+
+#### Returns
+
+`Promise`<`undefined` \| [`Claim`](modules_claims_claims_types.Claim.md)\>
+
+___
+
 ### getClaimsByIssuer
 
 ▸ **getClaimsByIssuer**(`issuer`, `filter?`): `Promise`<[`Claim`](modules_claims_claims_types.Claim.md)[]\>

diff --git a/src/modules/cacheClient/ICacheClient.ts b/src/modules/cacheClient/ICacheClient.ts
@@ -32,6 +32,7 @@ export interface ICacheClient {
     getClaimsByIssuer: (issuer: string, filter?: ClaimsFilter) => Promise<Claim[]>;
     getClaimsByRequester: (requester: string, filter?: ClaimsFilter) => Promise<Claim[]>;
     getClaimsBySubject: (subject: string, filter?: ClaimsFilter) => Promise<Claim[]>;
+    getClaimById: (claimId: string) => Promise<Claim | undefined>;
     requestClaim: (requester: string, message: IClaimRequest) => Promise<void>;
     issueClaim: (issuer: string, message: IClaimIssuance) => Promise<void>;
     rejectClaim: (issuer: string, message: IClaimRejection) => Promise<void>;

diff --git a/src/modules/cacheClient/cacheClient.service.ts b/src/modules/cacheClient/cacheClient.service.ts
@@ -231,6 +231,11 @@ export class CacheClient implements ICacheClient {
         return data;
     }
 
+    async getClaimById(claimId: string): Promise<Claim | undefined> {
+        const { data } = await this.httpClient.get<Claim | undefined>(`/claim/${claimId}`);
+        return data;
+    }
+
     async requestClaim(requester: string, message: IClaimRequest) {
         await this.httpClient.post<void>(`/claim/request/${requester}`, message);
     }

diff --git a/src/modules/claims/claims.service.ts b/src/modules/claims/claims.service.ts
@@ -104,6 +104,16 @@ export class ClaimsService {
         return this._cacheClient.getClaimsBySubject(did, { isAccepted, namespace });
     }
 
+    /**
+     * @description - Returns claim with the given Id or null if claim does not exist
+     */
+    async getClaimById(claimId: string) {
+        return this._cacheClient.getClaimById(claimId);
+    }
+    /**
+     * @description allows subject to request for credential
+     */
+
     async createClaimRequest({
         claim,
         subject = this._signerService.did,