@twin.org/api-auth-entity-storage-service 0.0.2-next.8 → 0.0.3-next.1

package/dist/types/services/entityStorageAuthenticationAdminService.d.ts

@@ -1,5 +1,5 @@
 import type { IAuthenticationAdminComponent } from "@twin.org/api-auth-entity-storage-models";
-import type { IEntityStorageAuthenticationAdminServiceConstructorOptions } from "../models/IEntityStorageAuthenticationAdminServiceConstructorOptions";
+import type { IEntityStorageAuthenticationAdminServiceConstructorOptions } from "../models/IEntityStorageAuthenticationAdminServiceConstructorOptions.js";
 /**
  * Implementation of the authentication component using entity storage.
  */
@@ -7,20 +7,26 @@ export declare class EntityStorageAuthenticationAdminService implements IAuthent
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of EntityStorageAuthentication.
      * @param options The dependencies for the identity connector.
      */
     constructor(options?: IEntityStorageAuthenticationAdminServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Create a login for the user.
      * @param email The email address for the user.
      * @param password The password for the user.
-     * @param identity The DID to associate with the account.
+     * @param userIdentity The DID to associate with the account.
+     * @param organizationIdentity The organization of the user.
      * @returns Nothing.
      */
-    create(email: string, password: string, identity: string): Promise<void>;
+    create(email: string, password: string, userIdentity: string, organizationIdentity: string): Promise<void>;
     /**
      * Remove the current user.
      * @param email The email address of the user to remove.

package/dist/types/services/entityStorageAuthenticationService.d.ts

@@ -1,5 +1,5 @@
 import type { IAuthenticationComponent } from "@twin.org/api-auth-entity-storage-models";
-import type { IEntityStorageAuthenticationServiceConstructorOptions } from "../models/IEntityStorageAuthenticationServiceConstructorOptions";
+import type { IEntityStorageAuthenticationServiceConstructorOptions } from "../models/IEntityStorageAuthenticationServiceConstructorOptions.js";
 /**
  * Implementation of the authentication component using entity storage.
  */
@@ -7,19 +7,23 @@ export declare class EntityStorageAuthenticationService implements IAuthenticati
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of EntityStorageAuthentication.
      * @param options The dependencies for the identity connector.
      */
     constructor(options?: IEntityStorageAuthenticationServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * The service needs to be started when the application is initialized.
-     * @param nodeIdentity The identity of the node.
      * @param nodeLoggingComponentType The node logging component type.
      * @returns Nothing.
      */
-    start(nodeIdentity: string, nodeLoggingComponentType?: string): Promise<void>;
+    start(nodeLoggingComponentType?: string): Promise<void>;
     /**
      * Perform a login for the user.
      * @param email The email address for the user.

package/dist/types/utils/passwordHelper.d.ts

@@ -2,6 +2,10 @@
  * Helper class for password operations.
  */
 export declare class PasswordHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Hash the password for the user.
      * @param passwordBytes The password bytes.

package/dist/types/utils/tokenHelper.d.ts

@@ -4,15 +4,20 @@ import { type IHttpHeaders, type IJwtHeader, type IJwtPayload } from "@twin.org/
  * Helper class for token operations.
  */
 export declare class TokenHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Create a new token.
      * @param vaultConnector The vault connector.
      * @param signingKeyName The signing key name.
-     * @param subject The subject for the token.
+     * @param userIdentity The subject for the token.
+     * @param organizationIdentity The organization for the token.
      * @param ttlMinutes The time to live for the token in minutes.
      * @returns The new token and its expiry date.
      */
-    static createToken(vaultConnector: IVaultConnector, signingKeyName: string, subject: string, ttlMinutes: number): Promise<{
+    static createToken(vaultConnector: IVaultConnector, signingKeyName: string, userIdentity: string, organizationIdentity: string | undefined, ttlMinutes: number): Promise<{
         token: string;
         expiry: number;
     }>;

package/docs/changelog.md

@@ -1,5 +1,112 @@
 # @twin.org/api-auth-entity-storage-service - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.3-next.0...api-auth-entity-storage-service-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use new extractBearer method ([3e0cc54](https://github.com/twinfoundation/api/commit/3e0cc5462c06f59a6b744386eeff8326e5abbc95))
+* use new extractBearerToken method ([df654e9](https://github.com/twinfoundation/api/commit/df654e9caee5bd62f0be36f7be9902c8fab6ead6))
+* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+    * @twin.org/api-core bumped from 0.0.3-next.0 to 0.0.3-next.1
+    * @twin.org/api-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.13](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.2-next.12...api-auth-entity-storage-service-v0.0.2-next.13) (2025-10-09)
+
+
+### 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.2-next.12 to 0.0.2-next.13
+    * @twin.org/api-core bumped from 0.0.2-next.12 to 0.0.2-next.13
+    * @twin.org/api-models bumped from 0.0.2-next.12 to 0.0.2-next.13
+
+## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.2-next.11...api-auth-entity-storage-service-v0.0.2-next.12) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from 0.0.2-next.11 to 0.0.2-next.12
+    * @twin.org/api-core bumped from 0.0.2-next.11 to 0.0.2-next.12
+    * @twin.org/api-models bumped from 0.0.2-next.11 to 0.0.2-next.12
+
+## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.2-next.10...api-auth-entity-storage-service-v0.0.2-next.11) (2025-09-29)
+
+
+### Features
+
+* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/api-core bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/api-models bumped from 0.0.2-next.10 to 0.0.2-next.11
+
+## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.2-next.9...api-auth-entity-storage-service-v0.0.2-next.10) (2025-09-23)
+
+
+### Features
+
+* use new extractBearer method ([3e0cc54](https://github.com/twinfoundation/api/commit/3e0cc5462c06f59a6b744386eeff8326e5abbc95))
+* use new extractBearerToken method ([df654e9](https://github.com/twinfoundation/api/commit/df654e9caee5bd62f0be36f7be9902c8fab6ead6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/api-core bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/api-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.2-next.8...api-auth-entity-storage-service-v0.0.2-next.9) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/api-core bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/api-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+
 ## [0.0.2-next.8](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.2-next.7...api-auth-entity-storage-service-v0.0.2-next.8) (2025-08-21)
 
 

package/docs/reference/classes/AuthHeaderProcessor.md

@@ -30,30 +30,38 @@ Options for the processor.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IBaseRouteProcessor.CLASS_NAME`
+`IBaseRouteProcessor.className`
 
-## Methods
+***
 
 ### start()
 
-> **start**(`nodeIdentity`, `nodeLoggingComponentType?`): `Promise`\<`void`\>
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
 The service needs to be started when the application is initialized.
 
 #### Parameters
 
-##### nodeIdentity
-
-`string`
-
-The identity of the node.
-
 ##### nodeLoggingComponentType?
 
 `string`
@@ -74,7 +82,7 @@ Nothing.
 
 ### pre()
 
-> **pre**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -96,13 +104,13 @@ The outgoing response.
 
 The route to process.
 
-`undefined` | `IBaseRoute`
+`IBaseRoute` | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-`IHttpRequestIdentity`
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 
@@ -120,7 +128,7 @@ The state handed through the processors.
 
 ### post()
 
-> **post**(`request`, `response`, `route`, `requestIdentity`, `processorState`): `Promise`\<`void`\>
+> **post**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -142,13 +150,13 @@ The outgoing response.
 
 The route to process.
 
-`undefined` | `IBaseRoute`
+`IBaseRoute` | `undefined`
 
-##### requestIdentity
+##### contextIds
 
-`IHttpRequestIdentity`
+`IContextIds`
 
-The identity context for the request.
+The context IDs of the request.
 
 ##### processorState
 

package/docs/reference/classes/AuthenticationUser.md

@@ -43,3 +43,11 @@ The salt for the password.
 > **identity**: `string`
 
 The user identity.
+
+***
+
+### organization
+
+> **organization**: `string`
+
+The users organization.

package/docs/reference/classes/EntityStorageAuthenticationAdminService.md

@@ -30,19 +30,33 @@ The dependencies for the identity connector.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IAuthenticationAdminComponent.CLASS_NAME`
+`IAuthenticationAdminComponent.className`
 
-## Methods
+***
 
 ### create()
 
-> **create**(`email`, `password`, `identity`): `Promise`\<`void`\>
+> **create**(`email`, `password`, `userIdentity`, `organizationIdentity`): `Promise`\<`void`\>
 
 Create a login for the user.
 
@@ -60,12 +74,18 @@ The email address for the user.
 
 The password for the user.
 
-##### identity
+##### userIdentity
 
 `string`
 
 The DID to associate with the account.
 
+##### organizationIdentity
+
+`string`
+
+The organization of the user.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/classes/EntityStorageAuthenticationService.md

@@ -30,30 +30,38 @@ The dependencies for the identity connector.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IAuthenticationComponent.CLASS_NAME`
+`IAuthenticationComponent.className`
 
-## Methods
+***
 
 ### start()
 
-> **start**(`nodeIdentity`, `nodeLoggingComponentType?`): `Promise`\<`void`\>
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
 The service needs to be started when the application is initialized.
 
 #### Parameters
 
-##### nodeIdentity
-
-`string`
-
-The identity of the node.
-
 ##### nodeLoggingComponentType?
 
 `string`

package/docs/reference/classes/PasswordHelper.md

@@ -12,6 +12,14 @@ Helper class for password operations.
 
 `PasswordHelper`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### hashPassword()

package/docs/reference/classes/TokenHelper.md

@@ -12,11 +12,19 @@ Helper class for token operations.
 
 `TokenHelper`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### createToken()
 
-> `static` **createToken**(`vaultConnector`, `signingKeyName`, `subject`, `ttlMinutes`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
+> `static` **createToken**(`vaultConnector`, `signingKeyName`, `userIdentity`, `organizationIdentity`, `ttlMinutes`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 Create a new token.
 
@@ -34,12 +42,18 @@ The vault connector.
 
 The signing key name.
 
-##### subject
+##### userIdentity
 
 `string`
 
 The subject for the token.
 
+##### organizationIdentity
+
+The organization for the token.
+
+`string` | `undefined`
+
 ##### ttlMinutes
 
 `number`
@@ -56,7 +70,7 @@ The new token and its expiry date.
 
 ### verify()
 
-> `static` **verify**(`vaultConnector`, `signingKeyName`, `token`): `Promise`\<\{ `header`: `IJwtHeader`; `payload`: `IJwtPayload`; \}\>
+> `static` **verify**(`vaultConnector`, `signingKeyName`, `token`): `Promise`\<\{ `header`: `JWTHeaderParameters`; `payload`: `JWTPayload`; \}\>
 
 Verify the token.
 
@@ -78,11 +92,11 @@ The signing key name.
 
 The token to verify.
 
-`undefined` | `string`
+`string` | `undefined`
 
 #### Returns
 
-`Promise`\<\{ `header`: `IJwtHeader`; `payload`: `IJwtPayload`; \}\>
+`Promise`\<\{ `header`: `JWTHeaderParameters`; `payload`: `JWTPayload`; \}\>
 
 The verified details.
 
@@ -94,7 +108,7 @@ UnauthorizedError if the token is missing, invalid or expired.
 
 ### extractTokenFromHeaders()
 
-> `static` **extractTokenFromHeaders**(`headers?`, `cookieName?`): `undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
+> `static` **extractTokenFromHeaders**(`headers?`, `cookieName?`): \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \} \| `undefined`
 
 Extract the auth token from the headers, either from the authorization header or the cookie header.
 
@@ -114,6 +128,6 @@ The name of the cookie to extract the token from.
 
 #### Returns
 
-`undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
+\{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \} \| `undefined`
 
 The token if found.

package/locales/en.json

@@ -2,25 +2,22 @@
 	"error": {
 		"entityStorageAuthenticationService": {
 			"loginFailed": "Login failed",
-			"refreshFailed": "Refresh failed",
 			"userNotFound": "The user with the specified e-mail could not be found",
 			"passwordMismatch": "The password does not match the user's password"
 		},
 		"entityStorageAuthenticationAdminService": {
 			"userExists": "The user with the specified e-mail already exists",
-			"createFailed": "Creating the user failed",
-			"removeFailed": "Removing the user failed",
+			"createUserFailed": "Creating the user failed",
+			"removeUserFailed": "Removing the user failed",
 			"updatePasswordFailed": "Updating the user's password failed",
 			"passwordTooShort": "The password is too short, it must be at least {minLength} characters long",
 			"userNotFound": "The user with the specified e-mail could not be found \"{notFoundId}\"",
 			"currentPasswordMismatch": "The current password is incorrect"
 		},
-		"entityStorageAuthenticationProcessor": {
-			"initializeFailed": "The JSON Web token authentication processor could not be initialized"
-		},
 		"tokenHelper": {
 			"missing": "The JSON Web token could not be found in the authorization header",
 			"payloadMissingSubject": "The JSON Web token payload does not contain a subject",
+			"payloadMissingOrganization": "The JSON Web token payload does not contain an organization",
 			"expired": "The JSON Web token has expired"
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-service",
-	"version": "0.0.2-next.8",
+	"version": "0.0.3-next.1",
 	"description": "Auth Entity Storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,10 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-models": "0.0.2-next.8",
-		"@twin.org/api-core": "0.0.2-next.8",
-		"@twin.org/api-models": "0.0.2-next.8",
+		"@twin.org/api-auth-entity-storage-models": "0.0.3-next.1",
+		"@twin.org/api-core": "0.0.3-next.1",
+		"@twin.org/api-models": "0.0.3-next.1",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/entity": "next",
@@ -26,21 +27,38 @@
 		"@twin.org/vault-models": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"entity",
+		"storage",
+		"persistence",
+		"database",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/api/issues"
+	},
+	"homepage": "https://twindev.org"
 }