@twin.org/api-auth-entity-storage-models 0.0.3-next.43 → 0.0.3-next.45

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

@@ -1 +1 @@
-{"version":3,"file":"IAuthenticationAdminComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IAuthenticationUser } from \"./IAuthenticationUser.js\";\n\n/**\n * Contract definition for authentication admin component.\n */\nexport interface IAuthenticationAdminComponent extends IComponent {\n\t/**\n\t * Create a login for the user.\n\t * @param user The user to create.\n\t * @returns Nothing.\n\t */\n\tcreate(user: IAuthenticationUser & { password: string }): Promise<void>;\n\n\t/**\n\t * Update a login for the user.\n\t * @param user The user to update.\n\t * @returns Nothing.\n\t */\n\tupdate(user: Partial<IAuthenticationUser>): Promise<void>;\n\n\t/**\n\t * Get a user by email.\n\t * @param email The email address of the user to get.\n\t * @returns The user details.\n\t */\n\tget(email: string): Promise<IAuthenticationUser>;\n\n\t/**\n\t * Get a user by identity.\n\t * @param identity The identity of the user to get.\n\t * @returns The user details.\n\t */\n\tgetByIdentity(identity: string): Promise<IAuthenticationUser>;\n\n\t/**\n\t * Remove a user.\n\t * @param email The email address of the user to remove.\n\t * @returns Nothing.\n\t */\n\tremove(email: string): Promise<void>;\n\n\t/**\n\t * Update the user's password.\n\t * @param email The email address of the user to update.\n\t * @param newPassword The new password for the user.\n\t * @param currentPassword The current password, optional, if supplied will check against existing.\n\t * @returns Nothing.\n\t */\n\tupdatePassword(email: string, newPassword: string, currentPassword?: string): Promise<void>;\n}\n"]}
+{"version":3,"file":"IAuthenticationAdminComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IAuthenticationUser } from \"./IAuthenticationUser.js\";\n\n/**\n * Contract definition for authentication admin component.\n */\nexport interface IAuthenticationAdminComponent extends IComponent {\n\t/**\n\t * Create a login for the user.\n\t * @param user The user to create.\n\t * @returns A promise that resolves when the user account has been created.\n\t */\n\tcreate(user: IAuthenticationUser & { password: string }): Promise<void>;\n\n\t/**\n\t * Update a login for the user.\n\t * @param user The user to update.\n\t * @returns A promise that resolves when the user account has been updated.\n\t */\n\tupdate(user: Partial<IAuthenticationUser>): Promise<void>;\n\n\t/**\n\t * Get a user by email.\n\t * @param email The email address of the user to get.\n\t * @returns The user details.\n\t */\n\tget(email: string): Promise<IAuthenticationUser>;\n\n\t/**\n\t * Get a user by identity.\n\t * @param identity The identity of the user to get.\n\t * @returns The user details.\n\t */\n\tgetByIdentity(identity: string): Promise<IAuthenticationUser>;\n\n\t/**\n\t * Remove a user.\n\t * @param email The email address of the user to remove.\n\t * @returns A promise that resolves when the user account has been removed.\n\t */\n\tremove(email: string): Promise<void>;\n\n\t/**\n\t * Update the user's password.\n\t * @param email The email address of the user to update.\n\t * @param newPassword The new password for the user.\n\t * @param currentPassword The current password, optional, if supplied will check against existing.\n\t * @returns A promise that resolves when the password has been updated.\n\t */\n\tupdatePassword(email: string, newPassword: string, currentPassword?: string): Promise<void>;\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"IAuthenticationComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Contract definition for authentication component.\n */\nexport interface IAuthenticationComponent extends IComponent {\n\t/**\n\t * Perform a login for the user.\n\t * @param email The email address for the user.\n\t * @param password The password for the user.\n\t * @returns The authentication token for the user, if it uses a mechanism with public access.\n\t */\n\tlogin(\n\t\temail: string,\n\t\tpassword: string\n\t): Promise<{\n\t\ttoken?: string;\n\t\texpiry: number;\n\t}>;\n\n\t/**\n\t * Logout the current user.\n\t * @param token The token to logout, if it uses a mechanism with public access.\n\t * @returns Nothing.\n\t */\n\tlogout(token?: string): Promise<void>;\n\n\t/**\n\t * Refresh the token.\n\t * @param token The token to refresh, if it uses a mechanism with public access.\n\t * @returns The refreshed token, if it uses a mechanism with public access.\n\t */\n\trefresh(token?: string): Promise<{\n\t\ttoken?: string;\n\t\texpiry: number;\n\t}>;\n\n\t/**\n\t * Update the user's password.\n\t * @param currentPassword The current password for the user.\n\t * @param newPassword The new password for the user.\n\t * @returns Nothing.\n\t */\n\tupdatePassword(currentPassword: string, newPassword: string): Promise<void>;\n}\n"]}
+{"version":3,"file":"IAuthenticationComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Contract definition for authentication component.\n */\nexport interface IAuthenticationComponent extends IComponent {\n\t/**\n\t * Perform a login for the user.\n\t * @param email The email address for the user.\n\t * @param password The password for the user.\n\t * @returns The authentication token for the user, if it uses a mechanism with public access.\n\t */\n\tlogin(\n\t\temail: string,\n\t\tpassword: string\n\t): Promise<{\n\t\ttoken?: string;\n\t\texpiry: number;\n\t}>;\n\n\t/**\n\t * Logout the current user.\n\t * @param token The token to logout, if it uses a mechanism with public access.\n\t * @returns A promise that resolves when the logout has been completed.\n\t */\n\tlogout(token?: string): Promise<void>;\n\n\t/**\n\t * Refresh the token.\n\t * @param token The token to refresh, if it uses a mechanism with public access.\n\t * @returns The refreshed token, if it uses a mechanism with public access.\n\t */\n\trefresh(token?: string): Promise<{\n\t\ttoken?: string;\n\t\texpiry: number;\n\t}>;\n\n\t/**\n\t * Update the user's password.\n\t * @param currentPassword The current password for the user.\n\t * @param newPassword The new password for the user.\n\t * @returns A promise that resolves when the password has been updated.\n\t */\n\tupdatePassword(currentPassword: string, newPassword: string): Promise<void>;\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"IAuthenticationRateComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationRateComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IAuthenticationRateActionConfig } from \"./IAuthenticationRateActionConfig.js\";\n\n/**\n * Contract definition for authentication rate component.\n */\nexport interface IAuthenticationRateComponent extends IComponent {\n\t/**\n\t * The service needs to be started when the application is initialized.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tstart(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/**\n\t * The component needs to be stopped when the node is closed.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tstop(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/**\n\t * Register or update rate-limit configuration for an action.\n\t * @param action The action name.\n\t * @param config The action configuration.\n\t * @returns Nothing.\n\t */\n\tregisterAction(action: string, config: IAuthenticationRateActionConfig): Promise<void>;\n\n\t/**\n\t * Unregister rate-limit configuration for an action.\n\t * @param action The action name.\n\t * @returns Nothing.\n\t */\n\tunregisterAction(action: string): Promise<void>;\n\n\t/**\n\t * Check the authentication rate for a given action and identifier.\n\t * @param action The action to be checked.\n\t * @param identifier The identifier to be checked.\n\t * @returns The result of the rate check.\n\t */\n\tcheck(action: string, identifier: string): Promise<string>;\n\n\t/**\n\t * Clear the authentication rate entry for the given action and identifier.\n\t * @param action The action to clear.\n\t * @param identifier The identifier to clear.\n\t * @returns Nothing.\n\t */\n\tclear(action: string, identifier: string): Promise<void>;\n}\n"]}
+{"version":3,"file":"IAuthenticationRateComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationRateComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IAuthenticationRateActionConfig } from \"./IAuthenticationRateActionConfig.js\";\n\n/**\n * Contract definition for authentication rate component.\n */\nexport interface IAuthenticationRateComponent extends IComponent {\n\t/**\n\t * The service needs to be started when the application is initialized.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns A promise that resolves when the service has been started.\n\t */\n\tstart(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/**\n\t * The component needs to be stopped when the node is closed.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns A promise that resolves when the service has been stopped.\n\t */\n\tstop(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/**\n\t * Register or update rate-limit configuration for an action.\n\t * @param action The action name.\n\t * @param config The action configuration.\n\t * @returns A promise that resolves when the action configuration has been stored.\n\t */\n\tregisterAction(action: string, config: IAuthenticationRateActionConfig): Promise<void>;\n\n\t/**\n\t * Unregister rate-limit configuration for an action.\n\t * @param action The action name.\n\t * @returns A promise that resolves when the action configuration has been removed.\n\t */\n\tunregisterAction(action: string): Promise<void>;\n\n\t/**\n\t * Check the authentication rate for a given action and identifier.\n\t * @param action The action to be checked.\n\t * @param identifier The identifier to be checked.\n\t * @returns The result of the rate check.\n\t */\n\tcheck(action: string, identifier: string): Promise<string>;\n\n\t/**\n\t * Clear the authentication rate entry for the given action and identifier.\n\t * @param action The action to clear.\n\t * @param identifier The identifier to clear.\n\t * @returns A promise that resolves when the rate entry has been removed.\n\t */\n\tclear(action: string, identifier: string): Promise<void>;\n}\n"]}

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

@@ -7,7 +7,7 @@ export interface IAuthenticationAdminComponent extends IComponent {
     /**
      * Create a login for the user.
      * @param user The user to create.
-     * @returns Nothing.
+     * @returns A promise that resolves when the user account has been created.
      */
     create(user: IAuthenticationUser & {
         password: string;
@@ -15,7 +15,7 @@ export interface IAuthenticationAdminComponent extends IComponent {
     /**
      * Update a login for the user.
      * @param user The user to update.
-     * @returns Nothing.
+     * @returns A promise that resolves when the user account has been updated.
      */
     update(user: Partial<IAuthenticationUser>): Promise<void>;
     /**
@@ -33,7 +33,7 @@ export interface IAuthenticationAdminComponent extends IComponent {
     /**
      * Remove a user.
      * @param email The email address of the user to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the user account has been removed.
      */
     remove(email: string): Promise<void>;
     /**
@@ -41,7 +41,7 @@ export interface IAuthenticationAdminComponent extends IComponent {
      * @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.
+     * @returns A promise that resolves when the password has been updated.
      */
     updatePassword(email: string, newPassword: string, currentPassword?: string): Promise<void>;
 }

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

@@ -16,7 +16,7 @@ export interface IAuthenticationComponent extends IComponent {
     /**
      * Logout the current user.
      * @param token The token to logout, if it uses a mechanism with public access.
-     * @returns Nothing.
+     * @returns A promise that resolves when the logout has been completed.
      */
     logout(token?: string): Promise<void>;
     /**
@@ -32,7 +32,7 @@ export interface IAuthenticationComponent extends IComponent {
      * Update the user's password.
      * @param currentPassword The current password for the user.
      * @param newPassword The new password for the user.
-     * @returns Nothing.
+     * @returns A promise that resolves when the password has been updated.
      */
     updatePassword(currentPassword: string, newPassword: string): Promise<void>;
 }

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

@@ -7,26 +7,26 @@ export interface IAuthenticationRateComponent extends IComponent {
     /**
      * The service needs to be started when the application is initialized.
      * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
+     * @returns A promise that resolves when the service has been started.
      */
     start(nodeLoggingComponentType?: string): Promise<void>;
     /**
      * The component needs to be stopped when the node is closed.
      * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
+     * @returns A promise that resolves when the service has been stopped.
      */
     stop(nodeLoggingComponentType?: string): Promise<void>;
     /**
      * Register or update rate-limit configuration for an action.
      * @param action The action name.
      * @param config The action configuration.
-     * @returns Nothing.
+     * @returns A promise that resolves when the action configuration has been stored.
      */
     registerAction(action: string, config: IAuthenticationRateActionConfig): Promise<void>;
     /**
      * Unregister rate-limit configuration for an action.
      * @param action The action name.
-     * @returns Nothing.
+     * @returns A promise that resolves when the action configuration has been removed.
      */
     unregisterAction(action: string): Promise<void>;
     /**
@@ -40,7 +40,7 @@ export interface IAuthenticationRateComponent extends IComponent {
      * Clear the authentication rate entry for the given action and identifier.
      * @param action The action to clear.
      * @param identifier The identifier to clear.
-     * @returns Nothing.
+     * @returns A promise that resolves when the rate entry has been removed.
      */
     clear(action: string, identifier: string): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.3-next.45](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.44...api-auth-entity-storage-models-v0.0.3-next.45) (2026-06-15)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.44](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.43...api-auth-entity-storage-models-v0.0.3-next.44) (2026-06-11)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
 ## [0.0.3-next.43](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.42...api-auth-entity-storage-models-v0.0.3-next.43) (2026-06-10)
 
 

package/docs/reference/interfaces/IAuthenticationAdminComponent.md

@@ -26,7 +26,7 @@ The user to create.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the user account has been created.
 
 ***
 
@@ -48,7 +48,7 @@ The user to update.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the user account has been updated.
 
 ***
 
@@ -114,7 +114,7 @@ The email address of the user to remove.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the user account has been removed.
 
 ***
 
@@ -148,4 +148,4 @@ The current password, optional, if supplied will check against existing.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the password has been updated.

package/docs/reference/interfaces/IAuthenticationComponent.md

@@ -54,7 +54,7 @@ The token to logout, if it uses a mechanism with public access.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the logout has been completed.
 
 ***
 
@@ -104,4 +104,4 @@ The new password for the user.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the password has been updated.

package/docs/reference/interfaces/IAuthenticationRateComponent.md

@@ -26,7 +26,7 @@ The node logging component type.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the service has been started.
 
 #### Overrides
 
@@ -52,7 +52,7 @@ The node logging component type.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the service has been stopped.
 
 #### Overrides
 
@@ -84,7 +84,7 @@ The action configuration.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the action configuration has been stored.
 
 ***
 
@@ -106,7 +106,7 @@ The action name.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the action configuration has been removed.
 
 ***
 
@@ -162,4 +162,4 @@ The identifier to clear.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the rate entry has been removed.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-models",
-	"version": "0.0.3-next.43",
+	"version": "0.0.3-next.45",
 	"description": "Contracts for authentication flows and admin user management with entity storage.",
 	"repository": {
 		"type": "git",