@twin.org/api-auth-entity-storage-rest-client 0.0.3-next.5 → 0.0.3-next.50

package/docs/reference/classes/EntityStorageAuthenticationRestClient.md

@@ -22,7 +22,7 @@ Create a new instance of EntityStorageAuthenticationRestClient.
 
 ##### config
 
-`IBaseRestClientConfig`
+[`IEntityStorageAuthenticationRestClientConstructorOptions`](../interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md)
 
 The configuration for the client.
 
@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +62,7 @@ The class name of the component.
 
 ***
 
-### login()
+### login() {#login}
 
 > **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
 
@@ -94,7 +94,7 @@ The authentication token for the user, if it uses a mechanism with public access
 
 ***
 
-### logout()
+### logout() {#logout}
 
 > **logout**(`token?`): `Promise`\<`void`\>
 
@@ -112,7 +112,7 @@ The token to logout, if it uses a mechanism with public access.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the logout request has completed.
 
 #### Implementation of
 
@@ -120,7 +120,7 @@ Nothing.
 
 ***
 
-### refresh()
+### refresh() {#refresh}
 
 > **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
 
@@ -146,20 +146,14 @@ The refreshed token, if it uses a mechanism with public access.
 
 ***
 
-### updatePassword()
+### updatePassword() {#updatepassword}
 
-> **updatePassword**(`email`, `currentPassword`, `newPassword`): `Promise`\<`void`\>
+> **updatePassword**(`currentPassword`, `newPassword`): `Promise`\<`void`\>
 
 Update the user's password.
 
 #### Parameters
 
-##### email
-
-`string`
-
-The email address of the user to update.
-
 ##### currentPassword
 
 `string`
@@ -176,8 +170,74 @@ The new password for the user.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the password has been updated on the server.
 
 #### Implementation of
 
 `IAuthenticationComponent.updatePassword`
+
+***
+
+### getEndpointWithPrefix() {#getendpointwithprefix}
+
+> **getEndpointWithPrefix**(): `string`
+
+Get the endpoint with the prefix for the namespace.
+
+#### Returns
+
+`string`
+
+The endpoint with namespace prefix attached.
+
+#### Inherited from
+
+`BaseRestClient.getEndpointWithPrefix`
+
+***
+
+### fetch() {#fetch}
+
+> **fetch**\<`T`, `U`\>(`route`, `method`, `request?`): `Promise`\<`U`\>
+
+Perform a request in json format.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `IHttpRequest`\<`any`\>
+
+##### U
+
+`U` *extends* `IHttpResponse`\<`any`\>
+
+#### Parameters
+
+##### route
+
+`string`
+
+The route of the request.
+
+##### method
+
+`HttpMethod`
+
+The http method.
+
+##### request?
+
+`T`
+
+Request to send to the endpoint.
+
+#### Returns
+
+`Promise`\<`U`\>
+
+The response.
+
+#### Inherited from
+
+`BaseRestClient.fetch`

package/docs/reference/index.md

@@ -2,4 +2,10 @@
 
 ## Classes
 
+- [EntityStorageAuthenticationAdminRestClient](classes/EntityStorageAuthenticationAdminRestClient.md)
+- [EntityStorageAuthenticationAuditRestClient](classes/EntityStorageAuthenticationAuditRestClient.md)
 - [EntityStorageAuthenticationRestClient](classes/EntityStorageAuthenticationRestClient.md)
+
+## Interfaces
+
+- [IEntityStorageAuthenticationRestClientConstructorOptions](interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md)

package/docs/reference/interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md

@@ -0,0 +1,141 @@
+# Interface: IEntityStorageAuthenticationRestClientConstructorOptions
+
+Options for the Entity Storage Authentication REST client constructor.
+
+## Extends
+
+- `IBaseRestClientConfig`
+
+## Properties
+
+### cookieName? {#cookiename}
+
+> `optional` **cookieName?**: `string`
+
+The name of the cookie to use for storing the auth token.
+
+#### Default
+
+```ts
+access_token
+```
+
+***
+
+### endpoint {#endpoint}
+
+> **endpoint**: `string`
+
+The endpoint where the api is hosted.
+
+#### Inherited from
+
+`IBaseRestClientConfig.endpoint`
+
+***
+
+### pathPrefix? {#pathprefix}
+
+> `optional` **pathPrefix?**: `string`
+
+The prefix to the routes.
+
+#### Inherited from
+
+`IBaseRestClientConfig.pathPrefix`
+
+***
+
+### headers? {#headers}
+
+> `optional` **headers?**: `IHttpHeaders`
+
+The headers to include in requests.
+
+#### Inherited from
+
+`IBaseRestClientConfig.headers`
+
+***
+
+### timeout? {#timeout}
+
+> `optional` **timeout?**: `number`
+
+Timeout for requests in ms.
+
+#### Inherited from
+
+`IBaseRestClientConfig.timeout`
+
+***
+
+### includeCredentials? {#includecredentials}
+
+> `optional` **includeCredentials?**: `boolean`
+
+Include credentials in the request, defaults to true.
+
+#### Inherited from
+
+`IBaseRestClientConfig.includeCredentials`
+
+***
+
+### customHeaders? {#customheaders}
+
+> `optional` **customHeaders?**: () => `Promise`\<`IHttpHeaders`\>
+
+Hook to provide headers asynchronously.
+
+#### Returns
+
+`Promise`\<`IHttpHeaders`\>
+
+A promise that resolves to the headers.
+
+#### Inherited from
+
+`IBaseRestClientConfig.customHeaders`
+
+***
+
+### customAuthHeader? {#customauthheader}
+
+> `optional` **customAuthHeader?**: () => `Promise`\<`string`\>
+
+Hook to provide an authorization header value asynchronously.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+A promise that resolves to the authorization header value.
+
+#### Inherited from
+
+`IBaseRestClientConfig.customAuthHeader`
+
+***
+
+### onAuthFailure? {#onauthfailure}
+
+> `optional` **onAuthFailure?**: (`err`) => `Promise`\<`void`\>
+
+Hook to handle authorization failures asynchronously.
+
+#### Parameters
+
+##### err
+
+`IError`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the auth failure handling is complete.
+
+#### Inherited from
+
+`IBaseRestClientConfig.onAuthFailure`

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-rest-client",
-	"version": "0.0.3-next.5",
-	"description": "Perform REST authentication using entity storage.",
+	"version": "0.0.3-next.50",
+	"description": "REST clients for authentication and admin operations against entity storage endpoints.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/api.git",
+		"url": "git+https://github.com/iotaledger/twin-api.git",
 		"directory": "packages/api-auth-entity-storage-rest-client"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-models": "0.0.3-next.5",
-		"@twin.org/api-core": "0.0.3-next.5",
-		"@twin.org/api-models": "0.0.3-next.5",
+		"@twin.org/api-auth-entity-storage-models": "0.0.3-next.50",
+		"@twin.org/api-core": "0.0.3-next.50",
+		"@twin.org/api-models": "0.0.3-next.50",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
@@ -49,7 +49,7 @@
 		"database"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/api/issues"
+		"url": "git+https://github.com/iotaledger/twin-api/issues"
 	},
 	"homepage": "https://twindev.org"
 }