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

package/dist/types/index.d.ts

@@ -3,4 +3,6 @@ export * from "./models/api/ILoginResponse";
 export * from "./models/api/ILogoutRequest";
 export * from "./models/api/IRefreshTokenRequest";
 export * from "./models/api/IRefreshTokenResponse";
+export * from "./models/api/IUpdatePasswordRequest";
+export * from "./models/IAuthenticationAdminComponent";
 export * from "./models/IAuthenticationComponent";

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

@@ -0,0 +1,28 @@
+import type { IComponent } from "@twin.org/core";
+/**
+ * Contract definition for authentication admin component.
+ */
+export interface IAuthenticationAdminComponent extends IComponent {
+    /**
+     * 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/models/IAuthenticationComponent.d.ts

@@ -28,4 +28,12 @@ export interface IAuthenticationComponent extends IComponent {
         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/models/api/IRefreshTokenRequest.d.ts

@@ -1,5 +1,5 @@
 /**
- * Perform a refresh on the auth token.
+ * Perform a refresh of the auth token.
  */
 export interface IRefreshTokenRequest {
     /**

package/dist/types/models/api/IUpdatePasswordRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Update a users password.
+ */
+export interface IUpdatePasswordRequest {
+    /**
+     * The path parameters for the request.
+     */
+    pathParams: {
+        /**
+         * The user email.
+         */
+        email: string;
+    };
+    /**
+     * The body of the request.
+     */
+    body: {
+        /**
+         * The current password for the user.
+         */
+        currentPassword: string;
+        /**
+         * The new password for the user.
+         */
+        newPassword: string;
+    };
+}

package/docs/changelog.md

@@ -1,5 +1,57 @@
 # @twin.org/api-auth-entity-storage-models - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.0...api-auth-entity-storage-models-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))
+* improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+* 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))
+
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
+
+## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.35...api-auth-entity-storage-models-v0.0.1-next.36) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.34...api-auth-entity-storage-models-v0.0.1-next.35) (2025-06-11)
+
+
+### Features
+
+* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+
+## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.33...api-auth-entity-storage-models-v0.0.1-next.34) (2025-05-27)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.32...api-auth-entity-storage-models-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))
+
+## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.31...api-auth-entity-storage-models-v0.0.1-next.32) (2025-03-28)
+
+
+### Features
+
+* improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+
+## v0.0.1-next.31
 
 - Initial Release

package/docs/reference/index.md

@@ -2,9 +2,11 @@
 
 ## Interfaces
 
+- [IAuthenticationAdminComponent](interfaces/IAuthenticationAdminComponent.md)
 - [IAuthenticationComponent](interfaces/IAuthenticationComponent.md)
 - [ILoginRequest](interfaces/ILoginRequest.md)
 - [ILoginResponse](interfaces/ILoginResponse.md)
 - [ILogoutRequest](interfaces/ILogoutRequest.md)
 - [IRefreshTokenRequest](interfaces/IRefreshTokenRequest.md)
 - [IRefreshTokenResponse](interfaces/IRefreshTokenResponse.md)
+- [IUpdatePasswordRequest](interfaces/IUpdatePasswordRequest.md)

package/docs/reference/interfaces/IAuthenticationAdminComponent.md

@@ -0,0 +1,97 @@
+# Interface: IAuthenticationAdminComponent
+
+Contract definition for authentication admin component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create()
+
+> **create**(`email`, `password`, `identity`): `Promise`\<`void`\>
+
+Create a login for the user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address for the user.
+
+##### password
+
+`string`
+
+The password for the user.
+
+##### identity
+
+`string`
+
+The DID to associate with the account.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### remove()
+
+> **remove**(`email`): `Promise`\<`void`\>
+
+Remove the current user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### updatePassword()
+
+> **updatePassword**(`email`, `newPassword`, `currentPassword?`): `Promise`\<`void`\>
+
+Update the user's password.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to update.
+
+##### newPassword
+
+`string`
+
+The new password for the user.
+
+##### currentPassword?
+
+`string`
+
+The current password, optional, if supplied will check against existing.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IAuthenticationComponent.md

@@ -10,45 +10,43 @@ Contract definition for authentication component.
 
 ### 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`
-
 ***
 
 ### logout()
 
-> **logout**(`token`?): `Promise`\<`void`\>
+> **logout**(`token?`): `Promise`\<`void`\>
 
 Logout the current user.
 
 #### Parameters
 
-• **token?**: `string`
+##### token?
+
+`string`
 
 The token to logout, if it uses a mechanism with public access.
 
@@ -62,26 +60,54 @@ 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?
+***
+
+### updatePassword()
+
+> **updatePassword**(`email`, `currentPassword`, `newPassword`): `Promise`\<`void`\>
 
-> `optional` **token**: `string`
+Update the user's password.
 
-##### expiry
+#### Parameters
+
+##### email
+
+`string`
+
+The email address of the user to update.
+
+##### currentPassword
+
+`string`
+
+The current password for the user.
+
+##### newPassword
 
-> **expiry**: `number`
+`string`
+
+The new password for the user.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IRefreshTokenRequest.md

@@ -1,6 +1,6 @@
 # Interface: IRefreshTokenRequest
 
-Perform a refresh on the auth token.
+Perform a refresh of the auth token.
 
 ## Properties
 

package/docs/reference/interfaces/IUpdatePasswordRequest.md

@@ -0,0 +1,37 @@
+# Interface: IUpdatePasswordRequest
+
+Update a users password.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters for the request.
+
+#### email
+
+> **email**: `string`
+
+The user email.
+
+***
+
+### body
+
+> **body**: `object`
+
+The body of the request.
+
+#### currentPassword
+
+> **currentPassword**: `string`
+
+The current password for the user.
+
+#### newPassword
+
+> **newPassword**: `string`
+
+The new password for the user.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-models",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Models which define the structure of the Auth Entity Storage contracts.",
 	"repository": {
 		"type": "git",
@@ -23,9 +23,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [