feat: update types and interfaces from ew-credentials

energywebfoundation · Jun 18, 2022 · 0ed9855 · 0ed9855
2 parents b318dbd + 55ff5b2
commit 0ed9855
Show file tree

Hide file tree

Showing 41 changed files with 13,891 additions and 6,173 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -8,4 +8,5 @@ module.exports = {
   parserOptions: {
     project: ['tsconfig.json', 'tsconfig.eslint.json'],
   },
+  ignorePatterns: ['src/utils/domains-build.js'],
 };
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,3 +1,80 @@
+## [6.0.0-alpha.18](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.17...v6.0.0-alpha.18) (2022-06-17)
+
+
+### Features
+
+* add credential revocation ([1f8f028](https://github.com/energywebfoundation/iam-client-lib/commit/1f8f0282a38853d3bc6fbbce3e02a028f68749ff))
+
+## [6.0.0-alpha.17](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.16...v6.0.0-alpha.17) (2022-06-16)
+
+
+### Bug Fixes
+
+* filter self-signed credential from presDef before sending to PEX ([6d43aeb](https://github.com/energywebfoundation/iam-client-lib/commit/6d43aeb5d7b530461ec92be663b30626e641c9db))
+
+## [6.0.0-alpha.16](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.15...v6.0.0-alpha.16) (2022-06-14)
+
+
+### Features
+
+* ens scripts ([d7f0df3](https://github.com/energywebfoundation/iam-client-lib/commit/d7f0df38c5eb0ff1d7b44159b6a83ec606927790))
+
+## [6.0.0-alpha.15](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.14...v6.0.0-alpha.15) (2022-06-13)
+
+## [6.0.0-alpha.14](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.13...v6.0.0-alpha.14) (2022-06-03)
+
+
+### Bug Fixes
+
+* **verifiable-credentials:** check errors in exchange initiating ([1bc8626](https://github.com/energywebfoundation/iam-client-lib/commit/1bc8626f0e97404c7f3edf222955c8c4399adfa8))
+
+## [6.0.0-alpha.13](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.12...v6.0.0-alpha.13) (2022-06-03)
+
+
+### Features
+
+* update claim revocation registry address ([effe1d8](https://github.com/energywebfoundation/iam-client-lib/commit/effe1d899d8316005759a2c0050ec4d4c3513d0b))
+
+## [6.0.0-alpha.12](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.11...v6.0.0-alpha.12) (2022-06-02)
+
+
+### Bug Fixes
+
+* add vp request to return of initiate exchange ([ddecbaf](https://github.com/energywebfoundation/iam-client-lib/commit/ddecbafe973c19b0acb17abb94fec062bacc5c62))
+
+## [6.0.0-alpha.11](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.10...v6.0.0-alpha.11) (2022-06-02)
+
+
+### Bug Fixes
+
+* on-chain claim revocation ([df9eeea](https://github.com/energywebfoundation/iam-client-lib/commit/df9eeea62ed6b05fb13dfec074d52267c5efa335))
+
+## [6.0.0-alpha.10](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.9...v6.0.0-alpha.10) (2022-06-02)
+
+
+### Features
+
+* **claims:** add status to vc ([28c556f](https://github.com/energywebfoundation/iam-client-lib/commit/28c556ffa0a9d53561507fdce95817a6672e43f3))
+* **verifiable-credentials:** add credential status eip712 type ([d9db01f](https://github.com/energywebfoundation/iam-client-lib/commit/d9db01ffe8cdaec5c7192f2ac134a7941e952555))
+
+## [6.0.0-alpha.9](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.8...v6.0.0-alpha.9) (2022-06-02)
+
+## [6.0.0-alpha.8](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.7...v6.0.0-alpha.8) (2022-06-01)
+
+## [6.0.0-alpha.7](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.6...v6.0.0-alpha.7) (2022-05-31)
+
+
+### Bug Fixes
+
+* **verifiable-credentials:** check errors on initiating exchange ([bce85a8](https://github.com/energywebfoundation/iam-client-lib/commit/bce85a8eca2a6abc2e89b93c13c44d63fa64bf02))
+
+## [6.0.0-alpha.6](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.5...v6.0.0-alpha.6) (2022-05-27)
+
+
+### Bug Fixes
+
+* exchange credential tests grouping ([2b1e674](https://github.com/energywebfoundation/iam-client-lib/commit/2b1e6746169b05756125d37595c5744aea12b8ee))
+
 ## [6.0.0-alpha.5](https://github.com/energywebfoundation/iam-client-lib/compare/v6.0.0-alpha.4...v6.0.0-alpha.5) (2022-05-24)
 
 

diff --git a/docs/api/classes/modules_cache_client.CacheClient.md b/docs/api/classes/modules_cache_client.CacheClient.md
@@ -23,6 +23,7 @@
 ### Methods
 
 - [addDIDToWatchList](modules_cache_client.CacheClient.md#adddidtowatchlist)
+- [addStatusToCredential](modules_cache_client.CacheClient.md#addstatustocredential)
 - [authenticate](modules_cache_client.CacheClient.md#authenticate)
 - [deleteClaim](modules_cache_client.CacheClient.md#deleteclaim)
 - [getAllowedRolesByIssuer](modules_cache_client.CacheClient.md#getallowedrolesbyissuer)
@@ -50,12 +51,15 @@
 - [getRoleDefinition](modules_cache_client.CacheClient.md#getroledefinition)
 - [getRolesByOwner](modules_cache_client.CacheClient.md#getrolesbyowner)
 - [getRolesDefinition](modules_cache_client.CacheClient.md#getrolesdefinition)
+- [getStatusListCredential](modules_cache_client.CacheClient.md#getstatuslistcredential)
 - [getSubOrganizationsByOrganization](modules_cache_client.CacheClient.md#getsuborganizationsbyorganization)
 - [handleError](modules_cache_client.CacheClient.md#handleerror)
 - [init](modules_cache_client.CacheClient.md#init)
+- [initiateCredentialStatusUpdate](modules_cache_client.CacheClient.md#initiatecredentialstatusupdate)
 - [isAuthEnabled](modules_cache_client.CacheClient.md#isauthenabled)
 - [issueClaim](modules_cache_client.CacheClient.md#issueclaim)
 - [login](modules_cache_client.CacheClient.md#login)
+- [persistCredentialStatusUpdate](modules_cache_client.CacheClient.md#persistcredentialstatusupdate)
 - [rejectClaim](modules_cache_client.CacheClient.md#rejectclaim)
 - [requestClaim](modules_cache_client.CacheClient.md#requestclaim)
 
@@ -113,6 +117,26 @@
 
 ___
 
+### addStatusToCredential
+
+▸ **addStatusToCredential**(`credential`): `Promise`<`Credential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> & { `credentialStatus`: `StatusList2021Entry`  }\>
+
+Sets location of the credential status
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `credential` | `Credential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | unsigned credential |
+
+#### Returns
+
+`Promise`<`Credential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> & { `credentialStatus`: `StatusList2021Entry`  }\>
+
+credential with reference to status location
+
+___
+
 ### authenticate
 
 ▸ **authenticate**(): `Promise`<`void`\>
@@ -650,6 +674,26 @@ ___
 
 ___
 
+### getStatusListCredential
+
+▸ **getStatusListCredential**(`credential`): `Promise`<``null`` \| [`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\>
+
+Fetch the StatusList2021Credential object from storage.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `credential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential with status list 2021 |
+
+#### Returns
+
+`Promise`<``null`` \| [`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\>
+
+status list credential if found
+
+___
+
 ### getSubOrganizationsByOrganization
 
 ▸ **getSubOrganizationsByOrganization**(`namespace`): `Promise`<[`IOrganization`](../interfaces/modules_domains.IOrganization.md)[]\>
@@ -700,6 +744,26 @@ ___
 
 ___
 
+### initiateCredentialStatusUpdate
+
+▸ **initiateCredentialStatusUpdate**(`verifiableCredential`): `Promise`<[`StatusList2021UnsignedCredential`](../interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md)\>
+
+Get the StatusList2021Credential object to be signed
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `verifiableCredential` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> | verifiable credential to be revoked |
+
+#### Returns
+
+`Promise`<[`StatusList2021UnsignedCredential`](../interfaces/modules_verifiable_credentials.StatusList2021UnsignedCredential.md)\>
+
+unsigned status list credential
+
+___
+
 ### isAuthEnabled
 
 ▸ **isAuthEnabled**(): `boolean`
@@ -752,6 +816,26 @@ https://energyweb.atlassian.net/wiki/spaces/MYEN/pages/2303295607/ICL-+ICS+Auth+
 
 ___
 
+### persistCredentialStatusUpdate
+
+▸ **persistCredentialStatusUpdate**(`statusListCredential`): `Promise`<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\>
+
+Persist signed StatusList2021Credential object in storage.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `statusListCredential` | [`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential) | signed status list |
+
+#### Returns
+
+`Promise`<[`StatusList2021Credential`](../modules/modules_verifiable_credentials.md#statuslist2021credential)\>
+
+status list credential
+
+___
+
 ### rejectClaim
 
 ▸ **rejectClaim**(`issuer`, `message`): `Promise`<`void`\>

diff --git a/docs/api/classes/modules_claims.ClaimsService.md b/docs/api/classes/modules_claims.ClaimsService.md
@@ -44,6 +44,7 @@ claimsService.getClaimById(claim.id);
 - [rejectClaimRequest](modules_claims.ClaimsService.md#rejectclaimrequest)
 - [revokeClaim](modules_claims.ClaimsService.md#revokeclaim)
 - [revokeMultipleClaim](modules_claims.ClaimsService.md#revokemultipleclaim)
+- [verifyVc](modules_claims.ClaimsService.md#verifyvc)
 - [create](modules_claims.ClaimsService.md#create)
 
 ## Constructors
@@ -740,6 +741,22 @@ claimsService.revokeMultipleClaim({
 
 ___
 
+### verifyVc
+
+▸ **verifyVc**(`vc`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `vc` | `VerifiableCredential`<[`RoleCredentialSubject`](../interfaces/modules_verifiable_credentials.RoleCredentialSubject.md)\> |
+
+#### Returns
+
+`Promise`<`void`\>
+
+___
+
 ### create
 
 ▸ `Static` **create**(`signerService`, `domainsService`, `cacheClient`, `didRegistry`, `verifiableCredentialService`): `Promise`<[`ClaimsService`](modules_claims.ClaimsService.md)\>

diff --git a/docs/api/classes/modules_did_registry.DidRegistry.md b/docs/api/classes/modules_did_registry.DidRegistry.md
@@ -23,6 +23,7 @@ didRegistry.getDidDocument();
 - [identityOwner](modules_did_registry.DidRegistry.md#identityowner)
 - [ipfsStore](modules_did_registry.DidRegistry.md#ipfsstore)
 - [jwt](modules_did_registry.DidRegistry.md#jwt)
+- [registrySettings](modules_did_registry.DidRegistry.md#registrysettings)
 
 ### Methods
 
@@ -87,6 +88,16 @@ ___
 
 `JWT`
 
+___
+
+### registrySettings
+
+• `get` **registrySettings**(): `RegistrySettings`
+
+#### Returns
+
+`RegistrySettings`
+
 ## Methods
 
 ### createDocument