@twin.org/api-auth-entity-storage-service 0.0.1-next.24 → 0.0.1-next.26

package/dist/cjs/index.cjs

@@ -34,19 +34,19 @@ exports.AuthenticationUser = class AuthenticationUser {
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], exports.AuthenticationUser.prototype, "email", void 0);
+], exports.AuthenticationUser.prototype, "email", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.AuthenticationUser.prototype, "password", void 0);
+], exports.AuthenticationUser.prototype, "password", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.AuthenticationUser.prototype, "salt", void 0);
+], exports.AuthenticationUser.prototype, "salt", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.AuthenticationUser.prototype, "identity", void 0);
+], exports.AuthenticationUser.prototype, "identity", undefined);
 exports.AuthenticationUser = __decorate([
     entity.entity()
 ], exports.AuthenticationUser);
@@ -190,8 +190,6 @@ class AuthHeaderProcessor {
     /**
      * 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) {
         this._vaultConnector = vaultModels.VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
@@ -547,9 +545,6 @@ class EntityStorageAuthenticationService {
     /**
      * 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) {
         this._userEntityStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.userEntityStorageType ?? "authentication-user");

package/dist/esm/index.mjs

@@ -32,19 +32,19 @@ let AuthenticationUser = class AuthenticationUser {
 __decorate([
     property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], AuthenticationUser.prototype, "email", void 0);
+], AuthenticationUser.prototype, "email", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], AuthenticationUser.prototype, "password", void 0);
+], AuthenticationUser.prototype, "password", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], AuthenticationUser.prototype, "salt", void 0);
+], AuthenticationUser.prototype, "salt", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], AuthenticationUser.prototype, "identity", void 0);
+], AuthenticationUser.prototype, "identity", undefined);
 AuthenticationUser = __decorate([
     entity()
 ], AuthenticationUser);
@@ -188,8 +188,6 @@ class AuthHeaderProcessor {
     /**
      * 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) {
         this._vaultConnector = VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
@@ -545,9 +543,6 @@ class EntityStorageAuthenticationService {
     /**
      * 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) {
         this._userEntityStorage = EntityStorageConnectorFactory.get(options?.userEntityStorageType ?? "authentication-user");

package/dist/types/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./entities/authenticationUser";
 export * from "./models/IAuthHeaderProcessorConfig";
+export * from "./models/IAuthHeaderProcessorConstructorOptions";
 export * from "./models/IEntityStorageAuthenticationServiceConfig";
+export * from "./models/IEntityStorageAuthenticationServiceConstructorOptions";
 export * from "./processors/authHeaderProcessor";
 export * from "./restEntryPoints";
 export * from "./routes/entityStorageAuthenticationRoutes";

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/IEntityStorageAuthenticationServiceConstructorOptions.d.ts

@@ -0,0 +1,20 @@
+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 configuration for the authentication.
+     */
+    config?: IEntityStorageAuthenticationServiceConfig;
+}

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

@@ -1,5 +1,5 @@
 import { type IBaseRoute, type IBaseRouteProcessor, type IHttpRequestIdentity, type IHttpResponse, type IHttpServerRequest } from "@twin.org/api-models";
-import type { IAuthHeaderProcessorConfig } from "../models/IAuthHeaderProcessorConfig";
+import type { IAuthHeaderProcessorConstructorOptions } from "../models/IAuthHeaderProcessorConstructorOptions";
 /**
  * Handle a JWT token in the authorization header or cookies and validate it to populate request context identity.
  */
@@ -15,13 +15,8 @@ export declare class AuthHeaderProcessor implements IBaseRouteProcessor {
     /**
      * 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.

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

@@ -1,5 +1,5 @@
 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.
  */
@@ -15,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.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-auth-entity-storage-service - Changelog
 
-## v0.0.1-next.24
+## v0.0.1-next.26
 
 - Initial Release

package/docs/reference/classes/AuthHeaderProcessor.md

@@ -16,17 +16,11 @@ Create a new instance of AuthCookiePreProcessor.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-Options for the processor.
-
-• **options.vaultConnectorType?**: `string`
-
-The vault for the private keys, defaults to "vault".
-
-• **options.config?**: [`IAuthHeaderProcessorConfig`](../interfaces/IAuthHeaderProcessorConfig.md)
+[`IAuthHeaderProcessorConstructorOptions`](../interfaces/IAuthHeaderProcessorConstructorOptions.md)
 
-The configuration for the processor.
+Options for the processor.
 
 #### Returns
 
@@ -62,11 +56,15 @@ 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".
 
@@ -90,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` \| `IBaseRoute`
+##### 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.
 
@@ -128,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` \| `IBaseRoute`
+##### 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.
 

package/docs/reference/classes/EntityStorageAuthenticationService.md

@@ -16,21 +16,11 @@ Create a new instance of EntityStorageAuthentication.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The dependencies for the identity connector.
-
-• **options.userEntityStorageType?**: `string`
-
-The entity storage for the users, defaults to "authentication-user".
-
-• **options.vaultConnectorType?**: `string`
-
-The vault for the private keys, defaults to "vault".
-
-• **options.config?**: [`IEntityStorageAuthenticationServiceConfig`](../interfaces/IEntityStorageAuthenticationServiceConfig.md)
+[`IEntityStorageAuthenticationServiceConstructorOptions`](../interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md)
 
-The configuration for the authentication.
+The dependencies for the identity connector.
 
 #### Returns
 
@@ -66,11 +56,15 @@ 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".
 
@@ -88,34 +82,30 @@ Nothing.
 
 ### login()
 
-> **login**(`email`, `password`): `Promise`\<`object`\>
+> **login**(`email`, `password`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 Perform a login for the user.
 
 #### Parameters
 
-• **email**: `string`
+##### email
+
+`string`
 
 The email address for the user.
 
-• **password**: `string`
+##### password
+
+`string`
 
 The password for the user.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 The authentication token for the user, if it uses a mechanism with public access.
 
-##### token?
-
-> `optional` **token**: `string`
-
-##### expiry
-
-> **expiry**: `number`
-
 #### Implementation of
 
 `IAuthenticationComponent.login`
@@ -130,7 +120,9 @@ Logout the current user.
 
 #### Parameters
 
-• **token?**: `string`
+##### token?
+
+`string`
 
 The token to logout, if it uses a mechanism with public access.
 
@@ -148,30 +140,24 @@ Nothing.
 
 ### refresh()
 
-> **refresh**(`token`?): `Promise`\<`object`\>
+> **refresh**(`token`?): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 Refresh the token.
 
 #### Parameters
 
-• **token?**: `string`
+##### token?
+
+`string`
 
 The token to refresh, if it uses a mechanism with public access.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 The refreshed token, if it uses a mechanism with public access.
 
-##### token
-
-> **token**: `string`
-
-##### expiry
-
-> **expiry**: `number`
-
 #### Implementation of
 
 `IAuthenticationComponent.refresh`

package/docs/reference/classes/PasswordHelper.md

@@ -22,11 +22,15 @@ Hash the password for the user.
 
 #### Parameters
 
-• **passwordBytes**: `Uint8Array`
+##### passwordBytes
+
+`Uint8Array`
 
 The password bytes.
 
-• **saltBytes**: `Uint8Array`
+##### saltBytes
+
+`Uint8Array`
 
 The salt bytes.
 

package/docs/reference/classes/TokenHelper.md

@@ -16,78 +16,76 @@ Helper class for token operations.
 
 ### createToken()
 
-> `static` **createToken**(`vaultConnector`, `signingKeyName`, `subject`, `ttlMinutes`): `Promise`\<`object`\>
+> `static` **createToken**(`vaultConnector`, `signingKeyName`, `subject`, `ttlMinutes`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 Create a new token.
 
 #### Parameters
 
-• **vaultConnector**: `IVaultConnector`
+##### vaultConnector
+
+`IVaultConnector`
 
 The vault connector.
 
-• **signingKeyName**: `string`
+##### signingKeyName
+
+`string`
 
 The signing key name.
 
-• **subject**: `string`
+##### subject
+
+`string`
 
 The subject for the token.
 
-• **ttlMinutes**: `number`
+##### ttlMinutes
+
+`number`
 
 The time to live for the token in minutes.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 The new token and its expiry date.
 
-##### token
-
-> **token**: `string`
-
-##### expiry
-
-> **expiry**: `number`
-
 ***
 
 ### verify()
 
-> `static` **verify**(`vaultConnector`, `signingKeyName`, `token`): `Promise`\<`object`\>
+> `static` **verify**(`vaultConnector`, `signingKeyName`, `token`): `Promise`\<\{ `header`: `IJwtHeader`; `payload`: `IJwtPayload`; \}\>
 
 Verify the token.
 
 #### Parameters
 
-• **vaultConnector**: `IVaultConnector`
+##### vaultConnector
+
+`IVaultConnector`
 
 The vault connector.
 
-• **signingKeyName**: `string`
+##### signingKeyName
+
+`string`
 
 The signing key name.
 
-• **token**: `undefined` \| `string`
+##### token
 
 The token to verify.
 
+`undefined` | `string`
+
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `header`: `IJwtHeader`; `payload`: `IJwtPayload`; \}\>
 
 The verified details.
 
-##### header
-
-> **header**: `IJwtHeader`
-
-##### payload
-
-> **payload**: `IJwtPayload`
-
 #### Throws
 
 UnauthorizedError if the token is missing, invalid or expired.
@@ -96,22 +94,26 @@ UnauthorizedError if the token is missing, invalid or expired.
 
 ### extractTokenFromHeaders()
 
-> `static` **extractTokenFromHeaders**(`headers`?, `cookieName`?): `undefined` \| `object`
+> `static` **extractTokenFromHeaders**(`headers`?, `cookieName`?): `undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
 
 Extract the auth token from the headers, either from the authorization header or the cookie header.
 
 #### Parameters
 
-• **headers?**: `IHttpHeaders`
+##### headers?
+
+`IHttpHeaders`
 
 The headers to extract the token from.
 
-• **cookieName?**: `string`
+##### cookieName?
+
+`string`
 
 The name of the cookie to extract the token from.
 
 #### Returns
 
-`undefined` \| `object`
+`undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
 
 The token if found.

package/docs/reference/functions/authenticationLogin.md

@@ -6,15 +6,21 @@ Login to the server.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ILoginRequest`
+### request
+
+`ILoginRequest`
 
 The request.
 

package/docs/reference/functions/authenticationLogout.md

@@ -6,15 +6,21 @@ Logout from the server.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ILogoutRequest`
+### request
+
+`ILogoutRequest`
 
 The request.
 

package/docs/reference/functions/authenticationRefreshToken.md

@@ -6,15 +6,21 @@ Refresh the login token.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IRefreshTokenRequest`
+### request
+
+`IRefreshTokenRequest`
 
 The request.
 

package/docs/reference/functions/generateRestRoutesAuthentication.md

@@ -6,11 +6,15 @@ The REST routes for authentication.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 

package/docs/reference/index.md

@@ -11,7 +11,9 @@
 ## Interfaces
 
 - [IAuthHeaderProcessorConfig](interfaces/IAuthHeaderProcessorConfig.md)
+- [IAuthHeaderProcessorConstructorOptions](interfaces/IAuthHeaderProcessorConstructorOptions.md)
 - [IEntityStorageAuthenticationServiceConfig](interfaces/IEntityStorageAuthenticationServiceConfig.md)
+- [IEntityStorageAuthenticationServiceConstructorOptions](interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md)
 
 ## Variables
 

package/docs/reference/interfaces/IAuthHeaderProcessorConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IAuthHeaderProcessorConstructorOptions
+
+Options for the AuthHeaderProcessor constructor.
+
+## Properties
+
+### vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+The vault for the private keys.
+
+#### Default
+
+```ts
+vault
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`IAuthHeaderProcessorConfig`](IAuthHeaderProcessorConfig.md)
+
+The configuration for the processor.

package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md

@@ -0,0 +1,39 @@
+# Interface: IEntityStorageAuthenticationServiceConstructorOptions
+
+Options for the EntityStorageAuthenticationService constructor.
+
+## Properties
+
+### userEntityStorageType?
+
+> `optional` **userEntityStorageType**: `string`
+
+The entity storage for the users.
+
+#### Default
+
+```ts
+authentication-user
+```
+
+***
+
+### vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+The vault for the private keys.
+
+#### Default
+
+```ts
+vault
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`IEntityStorageAuthenticationServiceConfig`](IEntityStorageAuthenticationServiceConfig.md)
+
+The configuration for the authentication.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-service",
-	"version": "0.0.1-next.24",
+	"version": "0.0.1-next.26",
 	"description": "Auth Entity Storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-models": "0.0.1-next.24",
-		"@twin.org/api-core": "0.0.1-next.24",
-		"@twin.org/api-models": "0.0.1-next.24",
+		"@twin.org/api-auth-entity-storage-models": "0.0.1-next.26",
+		"@twin.org/api-core": "0.0.1-next.26",
+		"@twin.org/api-models": "0.0.1-next.26",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/entity": "next",