feat: refactor auth from cache client

energywebfoundation · Mar 31, 2023 · 194a95d · 194a95d
1 parent 278f4a6
commit 194a95d
Show file tree

Hide file tree

Showing 15 changed files with 337 additions and 348 deletions.
diff --git a/docs/api/classes/modules_cache_client.CacheClient.md b/docs/api/classes/modules_cache_client.CacheClient.md
@@ -12,10 +12,6 @@
 
 - [constructor](modules_cache_client.CacheClient.md#constructor)
 
-### Properties
-
-- [pubKeyAndIdentityToken](modules_cache_client.CacheClient.md#pubkeyandidentitytoken)
-
 ### Accessors
 
 - [http](modules_cache_client.CacheClient.md#http)
@@ -77,16 +73,6 @@
 | :------ | :------ |
 | `_signerService` | [`SignerService`](modules_signer.SignerService.md) |
 
-## Properties
-
-### pubKeyAndIdentityToken
-
-• **pubKeyAndIdentityToken**: `undefined` \| [`IPubKeyAndIdentityToken`](../interfaces/modules_signer.IPubKeyAndIdentityToken.md)
-
-#### Implementation of
-
-[ICacheClient](../interfaces/modules_cache_client.ICacheClient.md).[pubKeyAndIdentityToken](../interfaces/modules_cache_client.ICacheClient.md#pubkeyandidentitytoken)
-
 ## Accessors
 
 ### http
@@ -143,11 +129,6 @@ ___
 
 ▸ **authenticate**(): `Promise`<`void`\>
 
-**`Description`**
-
-Refreshes access token. If login still fails then signs new identity token and requests access token
-After authentication runs previously failed requests
-
 #### Returns
 
 `Promise`<`void`\>
@@ -797,26 +778,16 @@ ___
 
 `boolean`
 
-#### Implementation of
-
-ICacheClient.isAuthEnabled
-
 ___
 
 ### isAuthenticated
 
 ▸ **isAuthenticated**(): `Promise`<`boolean`\>
 
-Checks that auth token has been created, has not expired and corresponds to signer.
-This is done by a request to the server because the auth token is stored in an HTTP-only cookie and
-so the Javascript has no way to check its validity
-
 #### Returns
 
 `Promise`<`boolean`\>
 
-true if cache client is authenticated server
-
 ___
 
 ### issueClaim
@@ -844,17 +815,10 @@ ___
 
 ▸ **login**(): `Promise`<`void`\>
 
-Verifies current session and establishes new one if needed
-https://energyweb.atlassian.net/wiki/spaces/MYEN/pages/2303295607/ICL-+ICS+Auth+Process
-
 #### Returns
 
 `Promise`<`void`\>
 
-#### Implementation of
-
-ICacheClient.login
-
 ___
 
 ### persistCredentialStatusUpdate

diff --git a/docs/api/interfaces/modules_cache_client.AuthTokens.md b/docs/api/interfaces/modules_cache_client.AuthTokens.md
diff --git a/docs/api/interfaces/modules_cache_client.CacheServerClientOptions.md b/docs/api/interfaces/modules_cache_client.CacheServerClientOptions.md
@@ -6,11 +6,18 @@
 
 ### Properties
 
+- [auth](modules_cache_client.CacheServerClientOptions.md#auth)
 - [cacheServerSupportsAuth](modules_cache_client.CacheServerClientOptions.md#cacheserversupportsauth)
 - [url](modules_cache_client.CacheServerClientOptions.md#url)
 
 ## Properties
 
+### auth
+
+• **auth**: `SiweOptions`
+
+___
+
 ### cacheServerSupportsAuth
 
 • `Optional` **cacheServerSupportsAuth**: `boolean`

diff --git a/docs/api/interfaces/modules_cache_client.ICacheClient.md b/docs/api/interfaces/modules_cache_client.ICacheClient.md
@@ -39,10 +39,7 @@
 - [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)
 - [issueClaim](modules_cache_client.ICacheClient.md#issueclaim)
-- [login](modules_cache_client.ICacheClient.md#login)
-- [pubKeyAndIdentityToken](modules_cache_client.ICacheClient.md#pubkeyandidentitytoken)
 - [rejectClaim](modules_cache_client.ICacheClient.md#rejectclaim)
 - [requestClaim](modules_cache_client.ICacheClient.md#requestclaim)
 
@@ -636,20 +633,6 @@ ___
 
 ___
 
-### isAuthEnabled
-
-• **isAuthEnabled**: () => `boolean`
-
-#### Type declaration
-
-▸ (): `boolean`
-
-##### Returns
-
-`boolean`
-
-___
-
 ### issueClaim
 
 • **issueClaim**: (`issuer`: `string`, `message`: [`IClaimIssuance`](modules_claims.IClaimIssuance.md)) => `Promise`<`void`\>
@@ -671,26 +654,6 @@ ___
 
 ___
 
-### login
-
-• **login**: () => `Promise`<`void`\>
-
-#### Type declaration
-
-▸ (): `Promise`<`void`\>
-
-##### Returns
-
-`Promise`<`void`\>
-
-___
-
-### pubKeyAndIdentityToken
-
-• **pubKeyAndIdentityToken**: `undefined` \| [`IPubKeyAndIdentityToken`](modules_signer.IPubKeyAndIdentityToken.md)
-
-___
-
 ### rejectClaim
 
 • **rejectClaim**: (`issuer`: `string`, `message`: [`IClaimRejection`](modules_claims.IClaimRejection.md)) => `Promise`<`void`\>

diff --git a/docs/api/modules/modules_cache_client.md b/docs/api/modules/modules_cache_client.md
@@ -13,7 +13,6 @@
 
 ### Interfaces
 
-- [AuthTokens](../interfaces/modules_cache_client.AuthTokens.md)
 - [CacheServerClientOptions](../interfaces/modules_cache_client.CacheServerClientOptions.md)
 - [ICacheClient](../interfaces/modules_cache_client.ICacheClient.md)
 
@@ -22,10 +21,6 @@
 - [AssetsFilter](modules_cache_client.md#assetsfilter)
 - [ClaimsFilter](modules_cache_client.md#claimsfilter)
 
-### Variables
-
-- [TEST\_LOGIN\_ENDPOINT](modules_cache_client.md#test_login_endpoint)
-
 ## Type Aliases
 
 ### AssetsFilter
@@ -53,9 +48,3 @@ ___
 | :------ | :------ |
 | `isAccepted?` | `boolean` |
 | `namespace?` | `string` |
-
-## Variables
-
-### TEST\_LOGIN\_ENDPOINT
-
-• `Const` **TEST\_LOGIN\_ENDPOINT**: ``"/auth/status"``