@twin.org/api-auth-entity-storage-service 0.0.1-next.9 → 0.0.2-next.1

package/dist/types/index.d.ts

@@ -1,10 +1,15 @@
 export * from "./entities/authenticationUser";
 export * from "./models/IAuthHeaderProcessorConfig";
+export * from "./models/IAuthHeaderProcessorConstructorOptions";
+export * from "./models/IEntityStorageAuthenticationAdminServiceConfig";
+export * from "./models/IEntityStorageAuthenticationAdminServiceConstructorOptions";
 export * from "./models/IEntityStorageAuthenticationServiceConfig";
+export * from "./models/IEntityStorageAuthenticationServiceConstructorOptions";
 export * from "./processors/authHeaderProcessor";
 export * from "./restEntryPoints";
 export * from "./routes/entityStorageAuthenticationRoutes";
 export * from "./schema";
+export * from "./services/entityStorageAuthenticationAdminService";
 export * from "./services/entityStorageAuthenticationService";
 export * from "./utils/passwordHelper";
 export * from "./utils/tokenHelper";

package/dist/types/models/IAuthHeaderProcessorConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+import type { IAuthHeaderProcessorConfig } from "./IAuthHeaderProcessorConfig";
+/**
+ * Options for the AuthHeaderProcessor constructor.
+ */
+export interface IAuthHeaderProcessorConstructorOptions {
+    /**
+     * The vault for the private keys.
+     * @default vault
+     */
+    vaultConnectorType?: string;
+    /**
+     * The configuration for the processor.
+     */
+    config?: IAuthHeaderProcessorConfig;
+}

package/dist/types/models/IEntityStorageAuthenticationAdminServiceConfig.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Configuration for the entity storage authentication admin service.
+ */
+export interface IEntityStorageAuthenticationAdminServiceConfig {
+    /**
+     * The minimum password length.
+     * @default 8
+     */
+    minPasswordLength?: number;
+}

package/dist/types/models/IEntityStorageAuthenticationAdminServiceConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+import type { IEntityStorageAuthenticationAdminServiceConfig } from "./IEntityStorageAuthenticationAdminServiceConfig";
+/**
+ * Options for the EntityStorageAuthenticationAdminService constructor.
+ */
+export interface IEntityStorageAuthenticationAdminServiceConstructorOptions {
+    /**
+     * The entity storage for the users.
+     * @default authentication-user
+     */
+    userEntityStorageType?: string;
+    /**
+     * The configuration for the authentication.
+     */
+    config?: IEntityStorageAuthenticationAdminServiceConfig;
+}

package/dist/types/models/IEntityStorageAuthenticationServiceConstructorOptions.d.ts

@@ -0,0 +1,25 @@
+import type { IEntityStorageAuthenticationServiceConfig } from "./IEntityStorageAuthenticationServiceConfig";
+/**
+ * Options for the EntityStorageAuthenticationService constructor.
+ */
+export interface IEntityStorageAuthenticationServiceConstructorOptions {
+    /**
+     * The entity storage for the users.
+     * @default authentication-user
+     */
+    userEntityStorageType?: string;
+    /**
+     * The vault for the private keys.
+     * @default vault
+     */
+    vaultConnectorType?: string;
+    /**
+     * The admin service.
+     * @default authentication-admin
+     */
+    authenticationAdminServiceType?: string;
+    /**
+     * The configuration for the authentication.
+     */
+    config?: IEntityStorageAuthenticationServiceConfig;
+}

package/dist/types/processors/authHeaderProcessor.d.ts

@@ -1,9 +1,13 @@
-import { type IHttpRequestIdentity, type IHttpResponse, type IHttpRestRouteProcessor, type IHttpServerRequest, type IRestRoute } from "@twin.org/api-models";
-import type { IAuthHeaderProcessorConfig } from "../models/IAuthHeaderProcessorConfig";
+import { type IBaseRoute, type IBaseRouteProcessor, type IHttpRequestIdentity, type IHttpResponse, type IHttpServerRequest } from "@twin.org/api-models";
+import type { IAuthHeaderProcessorConstructorOptions } from "../models/IAuthHeaderProcessorConstructorOptions";
 /**
  * Handle a JWT token in the authorization header or cookies and validate it to populate request context identity.
  */
-export declare class AuthHeaderProcessor implements IHttpRestRouteProcessor {
+export declare class AuthHeaderProcessor implements IBaseRouteProcessor {
+    /**
+     * The namespace supported by the processor.
+     */
+    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */
@@ -11,13 +15,8 @@ export declare class AuthHeaderProcessor implements IHttpRestRouteProcessor {
     /**
      * Create a new instance of AuthCookiePreProcessor.
      * @param options Options for the processor.
-     * @param options.vaultConnectorType The vault for the private keys, defaults to "vault".
-     * @param options.config The configuration for the processor.
      */
-    constructor(options?: {
-        vaultConnectorType?: string;
-        config?: IAuthHeaderProcessorConfig;
-    });
+    constructor(options?: IAuthHeaderProcessorConstructorOptions);
     /**
      * The service needs to be started when the application is initialized.
      * @param nodeIdentity The identity of the node.
@@ -33,7 +32,7 @@ export declare class AuthHeaderProcessor implements IHttpRestRouteProcessor {
      * @param requestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
      */
-    pre(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    pre(request: IHttpServerRequest, response: IHttpResponse, route: IBaseRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
     }): Promise<void>;
     /**
@@ -44,7 +43,7 @@ export declare class AuthHeaderProcessor implements IHttpRestRouteProcessor {
      * @param requestIdentity The identity context for the request.
      * @param processorState The state handed through the processors.
      */
-    post(request: IHttpServerRequest, response: IHttpResponse, route: IRestRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
+    post(request: IHttpServerRequest, response: IHttpResponse, route: IBaseRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
     }): Promise<void>;
 }

package/dist/types/routes/entityStorageAuthenticationRoutes.d.ts

@@ -1,4 +1,4 @@
-import type { ILoginRequest, ILoginResponse, ILogoutRequest, IRefreshTokenRequest, IRefreshTokenResponse } from "@twin.org/api-auth-entity-storage-models";
+import type { ILoginRequest, ILoginResponse, ILogoutRequest, IRefreshTokenRequest, IRefreshTokenResponse, IUpdatePasswordRequest } from "@twin.org/api-auth-entity-storage-models";
 import type { IHttpRequestContext, INoContentResponse, IRestRoute, IRestRouteResponseOptions, ITag } from "@twin.org/api-models";
 /**
  * The tag to associate with the routes.
@@ -35,3 +35,11 @@ export declare function authenticationLogout(httpRequestContext: IHttpRequestCon
  * @returns The response object with additional http response properties.
  */
 export declare function authenticationRefreshToken(httpRequestContext: IHttpRequestContext, componentName: string, request: IRefreshTokenRequest): Promise<IRefreshTokenResponse & IRestRouteResponseOptions>;
+/**
+ * Update the user's password.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function authenticationUpdatePassword(httpRequestContext: IHttpRequestContext, componentName: string, request: IUpdatePasswordRequest): Promise<INoContentResponse>;

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

@@ -0,0 +1,42 @@
+import type { IAuthenticationAdminComponent } from "@twin.org/api-auth-entity-storage-models";
+import type { IEntityStorageAuthenticationAdminServiceConstructorOptions } from "../models/IEntityStorageAuthenticationAdminServiceConstructorOptions";
+/**
+ * Implementation of the authentication component using entity storage.
+ */
+export declare class EntityStorageAuthenticationAdminService implements IAuthenticationAdminComponent {
+    /**
+     * The namespace supported by the authentication service.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of EntityStorageAuthentication.
+     * @param options The dependencies for the identity connector.
+     */
+    constructor(options?: IEntityStorageAuthenticationAdminServiceConstructorOptions);
+    /**
+     * 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.
+     * @returns Nothing.
+     */
+    create(email: string, password: string, identity: string): Promise<void>;
+    /**
+     * Remove the current user.
+     * @param email The email address of the user to remove.
+     * @returns Nothing.
+     */
+    remove(email: string): Promise<void>;
+    /**
+     * Update the user's password.
+     * @param email The email address of the user to update.
+     * @param newPassword The new password for the user.
+     * @param currentPassword The current password, optional, if supplied will check against existing.
+     * @returns Nothing.
+     */
+    updatePassword(email: string, newPassword: string, currentPassword?: string): Promise<void>;
+}

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

@@ -1,9 +1,13 @@
 import type { IAuthenticationComponent } from "@twin.org/api-auth-entity-storage-models";
-import type { IEntityStorageAuthenticationServiceConfig } from "../models/IEntityStorageAuthenticationServiceConfig";
+import type { IEntityStorageAuthenticationServiceConstructorOptions } from "../models/IEntityStorageAuthenticationServiceConstructorOptions";
 /**
  * Implementation of the authentication component using entity storage.
  */
 export declare class EntityStorageAuthenticationService implements IAuthenticationComponent {
+    /**
+     * The namespace supported by the authentication service.
+     */
+    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */
@@ -11,15 +15,8 @@ export declare class EntityStorageAuthenticationService implements IAuthenticati
     /**
      * Create a new instance of EntityStorageAuthentication.
      * @param options The dependencies for the identity connector.
-     * @param options.userEntityStorageType The entity storage for the users, defaults to "authentication-user".
-     * @param options.vaultConnectorType The vault for the private keys, defaults to "vault".
-     * @param options.config The configuration for the authentication.
      */
-    constructor(options?: {
-        userEntityStorageType?: string;
-        vaultConnectorType?: string;
-        config?: IEntityStorageAuthenticationServiceConfig;
-    });
+    constructor(options?: IEntityStorageAuthenticationServiceConstructorOptions);
     /**
      * The service needs to be started when the application is initialized.
      * @param nodeIdentity The identity of the node.
@@ -52,4 +49,12 @@ export declare class EntityStorageAuthenticationService implements IAuthenticati
         token: string;
         expiry: number;
     }>;
+    /**
+     * Update the user's password.
+     * @param email The email address of the user to update.
+     * @param currentPassword The current password for the user.
+     * @param newPassword The new password for the user.
+     * @returns Nothing.
+     */
+    updatePassword(email: string, currentPassword: string, newPassword: string): Promise<void>;
 }

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

@@ -1,4 +1,4 @@
-import type { IVaultConnector } from "@twin.org/vault-models";
+import { type IVaultConnector } from "@twin.org/vault-models";
 import { type IHttpHeaders, type IJwtHeader, type IJwtPayload } from "@twin.org/web";
 /**
  * Helper class for token operations.

package/docs/changelog.md

@@ -1,5 +1,119 @@
 # @twin.org/api-auth-entity-storage-service - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.2-next.0...api-auth-entity-storage-service-v0.0.2-next.1) (2025-07-08)
+
+
+### Features
+
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* 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.2-next.0 to 0.0.2-next.1
+    * @twin.org/api-core bumped from 0.0.2-next.0 to 0.0.2-next.1
+    * @twin.org/api-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from ^0.0.0 to ^0.0.1
+    * @twin.org/api-core bumped from ^0.0.0 to ^0.0.1
+    * @twin.org/api-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.1-next.35...api-auth-entity-storage-service-v0.0.1-next.36) (2025-06-17)
+
+
+### 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.1-next.35 to 0.0.1-next.36
+    * @twin.org/api-core bumped from 0.0.1-next.35 to 0.0.1-next.36
+    * @twin.org/api-models bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.1-next.34...api-auth-entity-storage-service-v0.0.1-next.35) (2025-06-11)
+
+
+### Features
+
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-auth-entity-storage-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+    * @twin.org/api-core bumped from 0.0.1-next.34 to 0.0.1-next.35
+    * @twin.org/api-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.1-next.33...api-auth-entity-storage-service-v0.0.1-next.34) (2025-05-27)
+
+
+### 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.1-next.33 to 0.0.1-next.34
+    * @twin.org/api-core bumped from 0.0.1-next.33 to 0.0.1-next.34
+    * @twin.org/api-models bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.1-next.32...api-auth-entity-storage-service-v0.0.1-next.33) (2025-04-17)
+
+
+### Features
+
+* 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.1-next.32 to 0.0.1-next.33
+    * @twin.org/api-core bumped from 0.0.1-next.32 to 0.0.1-next.33
+    * @twin.org/api-models bumped from 0.0.1-next.32 to 0.0.1-next.33
+
+## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.1-next.31...api-auth-entity-storage-service-v0.0.1-next.32) (2025-03-28)
+
+
+### 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.1-next.31 to 0.0.1-next.32
+    * @twin.org/api-core bumped from 0.0.1-next.31 to 0.0.1-next.32
+    * @twin.org/api-models bumped from 0.0.1-next.31 to 0.0.1-next.32
+
+## v0.0.1-next.31
 
 - Initial Release

package/docs/reference/classes/AuthHeaderProcessor.md

@@ -4,35 +4,37 @@ Handle a JWT token in the authorization header or cookies and validate it to pop
 
 ## Implements
 
-- `IHttpRestRouteProcessor`
+- `IBaseRouteProcessor`
 
 ## Constructors
 
-### new AuthHeaderProcessor()
+### Constructor
 
-> **new AuthHeaderProcessor**(`options`?): [`AuthHeaderProcessor`](AuthHeaderProcessor.md)
+> **new AuthHeaderProcessor**(`options?`): `AuthHeaderProcessor`
 
 Create a new instance of AuthCookiePreProcessor.
 
 #### Parameters
 
-• **options?**
+##### options?
+
+[`IAuthHeaderProcessorConstructorOptions`](../interfaces/IAuthHeaderProcessorConstructorOptions.md)
 
 Options for the processor.
 
-• **options.vaultConnectorType?**: `string`
+#### Returns
 
-The vault for the private keys, defaults to "vault".
+`AuthHeaderProcessor`
 
-• **options.config?**: [`IAuthHeaderProcessorConfig`](../interfaces/IAuthHeaderProcessorConfig.md)
+## Properties
 
-The configuration for the processor.
+### NAMESPACE
 
-#### Returns
+> `readonly` `static` **NAMESPACE**: `string` = `"auth-header"`
 
-[`AuthHeaderProcessor`](AuthHeaderProcessor.md)
+The namespace supported by the processor.
 
-## Properties
+***
 
 ### CLASS\_NAME
 
@@ -42,23 +44,27 @@ Runtime name for the class.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.CLASS_NAME`
+`IBaseRouteProcessor.CLASS_NAME`
 
 ## Methods
 
 ### start()
 
-> **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+> **start**(`nodeIdentity`, `nodeLoggingConnectorType?`): `Promise`\<`void`\>
 
 The service needs to be started when the application is initialized.
 
 #### Parameters
 
-• **nodeIdentity**: `string`
+##### nodeIdentity
+
+`string`
 
 The identity of the node.
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -70,7 +76,7 @@ Nothing.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.start`
+`IBaseRouteProcessor.start`
 
 ***
 
@@ -82,23 +88,31 @@ Pre process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -108,7 +122,7 @@ The state handed through the processors.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.pre`
+`IBaseRouteProcessor.pre`
 
 ***
 
@@ -120,23 +134,31 @@ Post process the REST request for the specified route.
 
 #### Parameters
 
-• **request**: `IHttpServerRequest`\<`any`\>
+##### request
+
+`IHttpServerRequest`
 
 The incoming request.
 
-• **response**: `IHttpResponse`\<`any`\>
+##### response
+
+`IHttpResponse`
 
 The outgoing response.
 
-• **route**: `undefined` \| `IRestRoute`\<`any`, `any`\>
+##### route
 
 The route to process.
 
-• **requestIdentity**: `IHttpRequestIdentity`
+`undefined` | `IBaseRoute`
+
+##### requestIdentity
+
+`IHttpRequestIdentity`
 
 The identity context for the request.
 
-• **processorState**
+##### processorState
 
 The state handed through the processors.
 
@@ -146,4 +168,4 @@ The state handed through the processors.
 
 #### Implementation of
 
-`IHttpRestRouteProcessor.post`
+`IBaseRouteProcessor.post`

package/docs/reference/classes/AuthenticationUser.md

@@ -4,13 +4,13 @@ Class defining the storage for user login credentials.
 
 ## Constructors
 
-### new AuthenticationUser()
+### Constructor
 
-> **new AuthenticationUser**(): [`AuthenticationUser`](AuthenticationUser.md)
+> **new AuthenticationUser**(): `AuthenticationUser`
 
 #### Returns
 
-[`AuthenticationUser`](AuthenticationUser.md)
+`AuthenticationUser`
 
 ## Properties