@twin.org/api-auth-entity-storage-rest-client 0.0.3-next.20 → 0.0.3-next.22

package/README.md

@@ -1,11 +1,11 @@
-# TWIN Auth Entity Storage
+# TWIN API Auth Entity Storage REST Client
 
-Perform REST authentication using entity storage.
+This package provides REST clients for authentication and admin operations against entity storage endpoints.
 
 ## Installation
 
 ```shell
-npm install @twin.org/api-auth-entity-storage
+npm install @twin.org/api-auth-entity-storage-rest-client
 ```
 
 ## Examples

package/dist/es/models/entityStorageAuthenticationRestClientConstructorOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"entityStorageAuthenticationRestClientConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/entityStorageAuthenticationRestClientConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRestClientConfig } from \"@twin.org/api-models\";\n\n/**\n * Options for the Entity Storage Authentication REST client constructor.\n */\nexport interface IEntityStorageAuthenticationRestClientConstructorOptions\n\textends IBaseRestClientConfig {\n\t/**\n\t * The name of the cookie to use for storing the auth token.\n\t * @default access_token\n\t */\n\tcookieName?: string;\n}\n"]}
+{"version":3,"file":"entityStorageAuthenticationRestClientConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/entityStorageAuthenticationRestClientConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseRestClientConfig } from \"@twin.org/api-models\";\n\n/**\n * Options for the Entity Storage Authentication REST client constructor.\n */\nexport interface IEntityStorageAuthenticationRestClientConstructorOptions extends IBaseRestClientConfig {\n\t/**\n\t * The name of the cookie to use for storing the auth token.\n\t * @default access_token\n\t */\n\tcookieName?: string;\n}\n"]}

package/docs/changelog.md

@@ -1,4 +1,36 @@
-# @twin.org/api-auth-entity-storage-rest-client - Changelog
+# Changelog
+
+## [0.0.3-next.22](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.3-next.21...api-auth-entity-storage-rest-client-v0.0.3-next.22) (2026-03-27)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from 0.0.3-next.21 to 0.0.3-next.22
+    * @twin.org/api-core bumped from 0.0.3-next.21 to 0.0.3-next.22
+    * @twin.org/api-models bumped from 0.0.3-next.21 to 0.0.3-next.22
+
+## [0.0.3-next.21](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.3-next.20...api-auth-entity-storage-rest-client-v0.0.3-next.21) (2026-03-11)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from 0.0.3-next.20 to 0.0.3-next.21
+    * @twin.org/api-core bumped from 0.0.3-next.20 to 0.0.3-next.21
+    * @twin.org/api-models bumped from 0.0.3-next.20 to 0.0.3-next.21
 
 ## [0.0.3-next.20](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-rest-client-v0.0.3-next.19...api-auth-entity-storage-rest-client-v0.0.3-next.20) (2026-02-09)
 

package/docs/examples.md

@@ -1 +1,73 @@
-# @twin.org/api-auth-entity-storage-rest-client - Examples
+# Auth Entity Storage Rest Client Examples
+
+Use these snippets to integrate sign-in and user administration flows from browser or server-side TypeScript applications.
+
+## EntityStorageAuthenticationAdminRestClient
+
+```typescript
+import { EntityStorageAuthenticationAdminRestClient } from '@twin.org/api-auth-entity-storage-rest-client';
+
+const adminClient = new EntityStorageAuthenticationAdminRestClient({
+  endpoint: 'https://api.example.org',
+  pathPrefix: 'v1'
+});
+
+console.log(adminClient.className()); // EntityStorageAuthenticationAdminRestClient
+
+await adminClient.create({
+  email: 'ops@example.org',
+  password: 'StrongPassword123',
+  userIdentity: 'did:example:ops',
+  organizationIdentity: 'did:example:core',
+  scope: ['admin']
+});
+
+await adminClient.update({
+  email: 'ops@example.org',
+  userIdentity: 'did:example:ops:team',
+  scope: ['admin', 'support']
+});
+
+await adminClient.updatePassword('ops@example.org', 'StrongPassword124', 'StrongPassword123');
+const adminUser = await adminClient.get('ops@example.org');
+console.log(adminUser.email); // ops@example.org
+```
+
+```typescript
+import { EntityStorageAuthenticationAdminRestClient } from '@twin.org/api-auth-entity-storage-rest-client';
+
+const adminClient = new EntityStorageAuthenticationAdminRestClient({
+  endpoint: 'https://api.example.org',
+  pathPrefix: 'v1'
+});
+
+const byEmail = await adminClient.get('ops@example.org');
+const byIdentity = await adminClient.getByIdentity('ops-team@example.org');
+await adminClient.remove('ops@example.org');
+
+console.log(byEmail.email); // ops@example.org
+console.log(byIdentity.userIdentity); // did:example:ops:team
+```
+
+## EntityStorageAuthenticationRestClient
+
+```typescript
+import { EntityStorageAuthenticationRestClient } from '@twin.org/api-auth-entity-storage-rest-client';
+
+const authClient = new EntityStorageAuthenticationRestClient({
+  endpoint: 'https://api.example.org',
+  pathPrefix: 'v1',
+  cookieName: 'access_token'
+});
+
+console.log(authClient.className()); // EntityStorageAuthenticationRestClient
+
+const loginResponse = await authClient.login('alice@example.org', 'correct-horse-battery-staple');
+
+await authClient.updatePassword('correct-horse-battery-staple', 'correct-horse-battery-staple-2');
+
+const refreshResponse = await authClient.refresh(loginResponse.token);
+
+await authClient.logout(refreshResponse.token);
+console.log(refreshResponse.expiry > 0); // true
+```

package/docs/reference/classes/EntityStorageAuthenticationAdminRestClient.md

@@ -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.
 
 ***
 
-### create()
+### create() {#create}
 
 > **create**(`user`): `Promise`\<`void`\>
 
@@ -88,7 +88,7 @@ Nothing.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`user`): `Promise`\<`void`\>
 
@@ -114,7 +114,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`email`): `Promise`\<`Omit`\<`IAuthenticationUser`, `"salt"` \| `"password"`\>\>
 
@@ -140,7 +140,7 @@ The user details.
 
 ***
 
-### getByIdentity()
+### getByIdentity() {#getbyidentity}
 
 > **getByIdentity**(`identity`): `Promise`\<`Omit`\<`IAuthenticationUser`, `"salt"` \| `"password"`\>\>
 
@@ -166,7 +166,7 @@ The user details.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`email`): `Promise`\<`void`\>
 
@@ -192,7 +192,7 @@ Nothing.
 
 ***
 
-### updatePassword()
+### updatePassword() {#updatepassword}
 
 > **updatePassword**(`email`, `newPassword`, `currentPassword?`): `Promise`\<`void`\>
 
@@ -227,3 +227,69 @@ Nothing.
 #### Implementation of
 
 `IAuthenticationAdminComponent.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/classes/EntityStorageAuthenticationRestClient.md

@@ -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`\>
 
@@ -120,7 +120,7 @@ Nothing.
 
 ***
 
-### refresh()
+### refresh() {#refresh}
 
 > **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
 
@@ -146,7 +146,7 @@ The refreshed token, if it uses a mechanism with public access.
 
 ***
 
-### updatePassword()
+### updatePassword() {#updatepassword}
 
 > **updatePassword**(`currentPassword`, `newPassword`): `Promise`\<`void`\>
 
@@ -175,3 +175,69 @@ Nothing.
 #### 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/interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md

@@ -8,9 +8,9 @@ Options for the Entity Storage Authentication REST client constructor.
 
 ## Properties
 
-### cookieName?
+### cookieName? {#cookiename}
 
-> `optional` **cookieName**: `string`
+> `optional` **cookieName?**: `string`
 
 The name of the cookie to use for storing the auth token.
 
@@ -19,3 +19,63 @@ The name of the cookie to use for storing the auth token.
 ```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`

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-rest-client",
-	"version": "0.0.3-next.20",
-	"description": "Perform REST authentication using entity storage.",
+	"version": "0.0.3-next.22",
+	"description": "REST clients for authentication and admin operations against entity storage endpoints.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/api.git",
@@ -14,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-models": "0.0.3-next.20",
-		"@twin.org/api-core": "0.0.3-next.20",
-		"@twin.org/api-models": "0.0.3-next.20",
+		"@twin.org/api-auth-entity-storage-models": "0.0.3-next.22",
+		"@twin.org/api-core": "0.0.3-next.22",
+		"@twin.org/api-models": "0.0.3-next.22",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"