@twin.org/api-auth-entity-storage-service 0.0.3-next.20 → 0.0.3-next.21

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Auth Entity Storage Service
+# TWIN API Auth Entity Storage Service
 
-Auth Entity Storage contract implementation and REST endpoint definitions.
+This package provides an authentication service implementation and REST routes backed by entity storage.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,20 @@
-# @twin.org/api-auth-entity-storage-service - Changelog
+# Changelog
+
+## [0.0.3-next.21](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.3-next.20...api-auth-entity-storage-service-v0.0.3-next.21) (2026-03-11)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-service:** 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-service-v0.0.3-next.19...api-auth-entity-storage-service-v0.0.3-next.20) (2026-02-09)
 

package/docs/examples.md

@@ -1 +1,88 @@
-# @twin.org/api-auth-entity-storage-service - Examples
+# Auth Entity Storage Service Examples
+
+These snippets show how to wire authentication services into your component container and apply token processing in request pipelines.
+
+## EntityStorageAuthenticationAdminService
+
+```typescript
+import { EntityStorageAuthenticationAdminService } from '@twin.org/api-auth-entity-storage-service';
+
+const adminService = new EntityStorageAuthenticationAdminService();
+
+console.log(adminService.className()); // EntityStorageAuthenticationAdminService
+
+await adminService.create({
+  email: 'owner@example.org',
+  password: 'StartPassword123',
+  userIdentity: 'did:example:owner',
+  organizationIdentity: 'did:example:org',
+  scope: ['admin']
+});
+
+await adminService.update({
+  email: 'owner@example.org',
+  scope: ['admin', 'security']
+});
+
+await adminService.updatePassword('owner@example.org', 'StartPassword124', 'StartPassword123');
+
+const fromIdentity = await adminService.getByIdentity('did:example:owner');
+console.log(fromIdentity.scope.length); // 2
+```
+
+```typescript
+import { EntityStorageAuthenticationAdminService } from '@twin.org/api-auth-entity-storage-service';
+
+const adminService = new EntityStorageAuthenticationAdminService();
+const user = await adminService.get('owner@example.org');
+await adminService.remove(user.email);
+
+console.log(user.email); // owner@example.org
+```
+
+## EntityStorageAuthenticationService
+
+```typescript
+import { EntityStorageAuthenticationService } from '@twin.org/api-auth-entity-storage-service';
+
+const authService = new EntityStorageAuthenticationService();
+
+await authService.start('default');
+console.log(authService.className()); // EntityStorageAuthenticationService
+
+const loginResult = await authService.login('alice@example.org', 'correct-horse-battery-staple');
+
+const refreshResult = await authService.refresh(loginResult.token);
+
+await authService.updatePassword('correct-horse-battery-staple', 'correct-horse-battery-staple-2');
+
+await authService.logout(refreshResult.token);
+console.log(refreshResult.expiry > 0); // true
+```
+
+## AuthHeaderProcessor
+
+```typescript
+import { AuthHeaderProcessor } from '@twin.org/api-auth-entity-storage-service';
+
+const processor = new AuthHeaderProcessor();
+
+await processor.start('default');
+console.log(processor.className()); // AuthHeaderProcessor
+
+const request = {
+  method: 'get',
+  url: '/info',
+  headers: {
+    authorization: 'Bearer token-value'
+  }
+};
+
+const response = {};
+const contextIds = {};
+const processorState: { [id: string]: unknown } = {};
+
+await processor.pre(request, response, { skipAuth: false }, contextIds, processorState);
+
+await processor.post(request, response, { skipAuth: false }, contextIds, processorState);
+```

package/docs/reference/interfaces/IAuthHeaderProcessorConfig.md

@@ -10,12 +10,6 @@ Configuration for the authentication header processor
 
 The name of the key to retrieve from the vault for signing JWT.
 
-#### Default
-
-```ts
-auth-signing
-```
-
 ***
 
 ### cookieName?
@@ -23,9 +17,3 @@ auth-signing
 > `optional` **cookieName**: `string`
 
 The name of the cookie to use for the token.
-
-#### Default
-
-```ts
-access_token
-```

package/docs/reference/interfaces/IAuthHeaderProcessorConstructorOptions.md

@@ -10,12 +10,6 @@ Options for the AuthHeaderProcessor constructor.
 
 The vault for the private keys.
 
-#### Default
-
-```ts
-vault
-```
-
 ***
 
 ### config?

package/docs/reference/interfaces/IEntityStorageAuthenticationAdminServiceConfig.md

@@ -9,9 +9,3 @@ Configuration for the entity storage authentication admin service.
 > `optional` **minPasswordLength**: `number`
 
 The minimum password length.
-
-#### Default
-
-```ts
-8
-```

package/docs/reference/interfaces/IEntityStorageAuthenticationAdminServiceConstructorOptions.md

@@ -10,12 +10,6 @@ Options for the EntityStorageAuthenticationAdminService constructor.
 
 The entity storage for the users.
 
-#### Default
-
-```ts
-authentication-user
-```
-
 ***
 
 ### config?

package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConfig.md

@@ -10,12 +10,6 @@ Configuration for the entity storage authentication service.
 
 The name of the key to retrieve from the vault for signing JWT.
 
-#### Default
-
-```ts
-auth-signing
-```
-
 ***
 
 ### defaultTtlMinutes?
@@ -23,9 +17,3 @@ auth-signing
 > `optional` **defaultTtlMinutes**: `number`
 
 The default time to live for the JWT.
-
-#### Default
-
-```ts
-1440
-```

package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md

@@ -10,12 +10,6 @@ Options for the EntityStorageAuthenticationService constructor.
 
 The entity storage for the users.
 
-#### Default
-
-```ts
-authentication-user
-```
-
 ***
 
 ### vaultConnectorType?
@@ -24,12 +18,6 @@ authentication-user
 
 The vault for the private keys.
 
-#### Default
-
-```ts
-vault
-```
-
 ***
 
 ### authenticationAdminServiceType?
@@ -38,12 +26,6 @@ vault
 
 The admin service.
 
-#### Default
-
-```ts
-authentication-admin
-```
-
 ***
 
 ### config?

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-service",
-	"version": "0.0.3-next.20",
-	"description": "Auth Entity Storage contract implementation and REST endpoint definitions",
+	"version": "0.0.3-next.21",
+	"description": "Authentication service implementation and REST routes backed by entity storage.",
 	"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.21",
+		"@twin.org/api-core": "0.0.3-next.21",
+		"@twin.org/api-models": "0.0.3-next.21",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",