@3sixty/api-auth-entity-storage-models 0.0.0-stage → 0.20.0-next.1

package/docs/reference/interfaces/IAuthenticationComponent.md

@@ -0,0 +1,121 @@
+# Interface: IAuthenticationComponent
+
+Contract definition for authentication component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### login() {#login}
+
+> **login**(`email`, `password`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+Perform a login for the user.
+
+#### Parameters
+
+##### email
+
+`string`
+
+The email address for the user.
+
+##### password
+
+`string`
+
+The password for the user.
+
+#### Returns
+
+`Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+The authentication token for the user, if it uses a mechanism with public access.
+
+***
+
+### logout() {#logout}
+
+> **logout**(`token?`): `Promise`\<`void`\>
+
+Logout the current user.
+
+#### Parameters
+
+##### token?
+
+`string`
+
+The token to logout, if it uses a mechanism with public access.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the logout has been completed.
+
+***
+
+### refresh() {#refresh}
+
+> **refresh**(`token?`): `Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+Refresh the token.
+
+#### Parameters
+
+##### token?
+
+`string`
+
+The token to refresh, if it uses a mechanism with public access.
+
+#### Returns
+
+`Promise`\<\{ `token?`: `string`; `expiry`: `number`; \}\>
+
+The refreshed token, if it uses a mechanism with public access.
+
+***
+
+### updatePassword() {#updatepassword}
+
+> **updatePassword**(`currentPassword`, `newPassword`): `Promise`\<`void`\>
+
+Update the user's password.
+
+#### Parameters
+
+##### currentPassword
+
+`string`
+
+The current password for the user.
+
+##### newPassword
+
+`string`
+
+The new password for the user.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the password has been updated.
+
+***
+
+### passwordPolicy() {#passwordpolicy}
+
+> **passwordPolicy**(): `Promise`\<[`IPasswordOptions`](IPasswordOptions.md)\>
+
+Get the password policy used for password validation.
+
+#### Returns
+
+`Promise`\<[`IPasswordOptions`](IPasswordOptions.md)\>
+
+The password policy options.

package/docs/reference/interfaces/IAuthenticationUser.md

@@ -0,0 +1,31 @@
+# Interface: IAuthenticationUser
+
+Contract definition for authentication user.
+
+## Extended by
+
+- [`IAuthenticationUserSecure`](IAuthenticationUserSecure.md)
+
+## Properties
+
+### email {#email}
+
+> **email**: `string`
+
+The user e-mail address.
+
+***
+
+### userIdentity {#useridentity}
+
+> **userIdentity**: `string`
+
+The user identity.
+
+***
+
+### organizationIdentity {#organizationidentity}
+
+> **organizationIdentity**: `string`
+
+The users organization.

package/docs/reference/interfaces/IAuthenticationUserSecure.md

@@ -0,0 +1,67 @@
+# Interface: IAuthenticationUserSecure
+
+Contract definition for authentication user.
+
+## Extends
+
+- [`IAuthenticationUser`](IAuthenticationUser.md)
+
+## Properties
+
+### email {#email}
+
+> **email**: `string`
+
+The user e-mail address.
+
+#### Inherited from
+
+[`IAuthenticationUser`](IAuthenticationUser.md).[`email`](IAuthenticationUser.md#email)
+
+***
+
+### userIdentity {#useridentity}
+
+> **userIdentity**: `string`
+
+The user identity.
+
+#### Inherited from
+
+[`IAuthenticationUser`](IAuthenticationUser.md).[`userIdentity`](IAuthenticationUser.md#useridentity)
+
+***
+
+### organizationIdentity {#organizationidentity}
+
+> **organizationIdentity**: `string`
+
+The users organization.
+
+#### Inherited from
+
+[`IAuthenticationUser`](IAuthenticationUser.md).[`organizationIdentity`](IAuthenticationUser.md#organizationidentity)
+
+***
+
+### password {#password}
+
+> **password**: `string`
+
+The encrypted password for the user.
+
+***
+
+### salt {#salt}
+
+> **salt**: `string`
+
+The salt for the password.
+
+***
+
+### tenantId {#tenantid}
+
+> **tenantId**: `string`
+
+The tenant ID associated with the user, optional in single tenant contexts.

package/docs/reference/interfaces/ILoginRequest.md

@@ -0,0 +1,23 @@
+# Interface: ILoginRequest
+
+Perform a login on the server.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The login details.
+
+#### email
+
+> **email**: `string`
+
+The email address for the user.
+
+#### password
+
+> **password**: `string`
+
+The password for the user.

package/docs/reference/interfaces/ILoginResponse.md

@@ -0,0 +1,31 @@
+# Interface: ILoginResponse
+
+Response from a login on the server.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+Response headers.
+
+#### set-cookie?
+
+> `optional` **set-cookie?**: `string`
+
+The cookie containing the auth token.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The login response details.
+
+#### expiry
+
+> **expiry**: `number`
+
+The expiry time of the token.

package/docs/reference/interfaces/ILogoutRequest.md

@@ -0,0 +1,17 @@
+# Interface: ILogoutRequest
+
+Perform a logout on the auth token.
+
+## Properties
+
+### body? {#body}
+
+> `optional` **body?**: `object`
+
+The logout token details.
+
+#### token?
+
+> `optional` **token?**: `string`
+
+The token to logout, if it uses a mechanism with public access.

package/docs/reference/interfaces/IPasswordOptions.md

@@ -0,0 +1,19 @@
+# Interface: IPasswordOptions
+
+Password length validation options.
+
+## Properties
+
+### minPasswordLength? {#minpasswordlength}
+
+> `optional` **minPasswordLength?**: `number`
+
+The minimum password length for validation.
+
+***
+
+### maxPasswordLength? {#maxpasswordlength}
+
+> `optional` **maxPasswordLength?**: `number`
+
+The maximum password length for validation.

package/docs/reference/interfaces/IPasswordPolicyResponse.md

@@ -0,0 +1,11 @@
+# Interface: IPasswordPolicyResponse
+
+Get the password policy.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IPasswordOptions`](IPasswordOptions.md)
+
+The body of the response.

package/docs/reference/interfaces/IRefreshTokenRequest.md

@@ -0,0 +1,17 @@
+# Interface: IRefreshTokenRequest
+
+Perform a refresh of the auth token.
+
+## Properties
+
+### body? {#body}
+
+> `optional` **body?**: `object`
+
+The refresh token details.
+
+#### token?
+
+> `optional` **token?**: `string`
+
+The token to refresh, if it uses a mechanism with public access.

package/docs/reference/interfaces/IRefreshTokenResponse.md

@@ -0,0 +1,31 @@
+# Interface: IRefreshTokenResponse
+
+Response from a refresh on the auth token.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+Response headers.
+
+#### set-cookie?
+
+> `optional` **set-cookie?**: `string`
+
+The cookie containing the auth token.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The refresh token details.
+
+#### expiry
+
+> **expiry**: `number`
+
+The expiry time of the token.

package/docs/reference/interfaces/IUpdatePasswordRequest.md

@@ -0,0 +1,23 @@
+# Interface: IUpdatePasswordRequest
+
+Update the current user's password.
+
+## Properties
+
+### body {#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/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,6 +1,55 @@
 {
-  "name": "@3sixty/api-auth-entity-storage-models",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-auth-entity-storage-models",
+	"version": "0.20.0-next.1",
+	"description": "Contracts for authentication flows and admin user management with entity storage.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api-auth.git",
+		"directory": "packages/api-auth-entity-storage-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/core": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/web": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		}
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"entity",
+		"storage",
+		"persistence",
+		"database",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api-auth/issues"
+	},
+	"homepage": "https://3sixty.global"
+}