@3sixty/api-auth-entity-storage-service 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md

@@ -0,0 +1,81 @@
+# Interface: IEntityStorageAuthenticationServiceConstructorOptions
+
+Options for the EntityStorageAuthenticationService constructor.
+
+## Properties
+
+### userEntityStorageType? {#userentitystoragetype}
+
+> `optional` **userEntityStorageType?**: `string`
+
+The entity storage for the users.
+
+#### Default
+
+```ts
+authentication-user
+```
+
+***
+
+### vaultConnectorType? {#vaultconnectortype}
+
+> `optional` **vaultConnectorType?**: `string`
+
+The vault for the private keys.
+
+#### Default
+
+```ts
+vault
+```
+
+***
+
+### authenticationAuditServiceType? {#authenticationauditservicetype}
+
+> `optional` **authenticationAuditServiceType?**: `string`
+
+The audit service.
+
+#### Default
+
+```ts
+authentication-audit
+```
+
+***
+
+### authenticationRateServiceType? {#authenticationrateservicetype}
+
+> `optional` **authenticationRateServiceType?**: `string`
+
+The rate service.
+
+#### Default
+
+```ts
+authentication-rate
+```
+
+***
+
+### tenantAdminComponentType? {#tenantadmincomponenttype}
+
+> `optional` **tenantAdminComponentType?**: `string`
+
+The component to retrieve tenant information.
+
+#### Default
+
+```ts
+tenant-admin
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IEntityStorageAuthenticationServiceConfig`](IEntityStorageAuthenticationServiceConfig.md)
+
+The configuration for the authentication.

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,5 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+REST entry points for the authentication, authentication admin, and authentication audit services.

package/docs/reference/variables/tagsAuthentication.md

@@ -0,0 +1,5 @@
+# Variable: tagsAuthentication
+
+> `const` **tagsAuthentication**: `ITag`[]
+
+The tag to associate with the routes.

package/docs/reference/variables/tagsAuthenticationAdmin.md

@@ -0,0 +1,5 @@
+# Variable: tagsAuthenticationAdmin
+
+> `const` **tagsAuthenticationAdmin**: `ITag`[]
+
+The tag to associate with the routes.

package/docs/reference/variables/tagsAuthenticationAudit.md

@@ -0,0 +1,5 @@
+# Variable: tagsAuthenticationAudit
+
+> `const` **tagsAuthenticationAudit**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,52 @@
+{
+	"error": {
+		"entityStorageAuthenticationService": {
+			"loginFailed": "Login failed",
+			"userNotFound": "The user with the specified e-mail could not be found",
+			"passwordMismatch": "The password does not match the user's password",
+			"nodeIdNotSet": "The node ID has not been set"
+		},
+		"entityStorageAuthenticationAdminService": {
+			"userExists": "The user with the specified e-mail already exists",
+			"createUserFailed": "Creating the user failed",
+			"getUserFailed": "Getting the user failed",
+			"updateUserFailed": "Updating the user failed",
+			"removeUserFailed": "Removing the user failed",
+			"updatePasswordFailed": "Updating the user's password failed",
+			"userNotFound": "The user with the specified e-mail could not be found \"{notFoundId}\"",
+			"insufficientScopeForEscalatedPrivilege": "Caller does not hold the required scope \"{scopeName}\" to assign a role with escalated privilege.",
+			"insufficientScopeForEscalatedTarget": "Caller does not hold the required scope \"{scopeName}\" to modify an account with escalated privilege."
+		},
+		"authHeaderProcessor": {
+			"nodeIdNotSet": "The node ID has not been set"
+		},
+		"passwordHelper": {
+			"currentPasswordMismatch": "The current password is incorrect"
+		},
+		"entityStorageAuthenticationAuditService": {
+			"auditEntryNotFound": "The audit entry with the specified identifier could not be found \"{notFoundId}\"",
+			"getAuditEntryFailed": "Getting the audit entry failed",
+			"updateAuditEntryFailed": "Updating the audit entry failed",
+			"removeAuditEntryFailed": "Removing the audit entry failed"
+		},
+		"entityStorageAuthenticationRateService": {
+			"actionConfigMissing": "No rate-limit configuration exists for action \"{action}\".",
+			"rateLimitExceeded": "The rate limit for action \"{action}\" has been exceeded. Retry after {retryAfterSeconds} seconds."
+		},
+		"tokenHelper": {
+			"missing": "The JSON Web token could not be found in the authorization header",
+			"headerKeyIdMismatch": "The JSON Web token key identifier does not match the expected signing key",
+			"payloadIssuerMismatch": "The JSON Web token issuer does not match the expected signing key",
+			"payloadMissingSubject": "The JSON Web token payload does not contain a subject",
+			"payloadMissingOrganization": "The JSON Web token payload does not contain an organization",
+			"expired": "The JSON Web token has expired",
+			"insufficientScopes": "The JSON Web token does not have the required scopes to access this resource",
+			"userNotVerified": "The user associated with the JSON Web token could not be verified",
+			"organizationNotVerified": "The organization associated with the JSON Web token could not be verified",
+			"tenantNotVerified": "The tenant associated with the JSON Web token could not be verified"
+		},
+		"validation": {
+			"saltEntropyTooLow": "Salt must have at least 8 unique characters for sufficient entropy."
+		}
+	}
+}

package/package.json

@@ -1,6 +1,65 @@
 {
-  "name": "@3sixty/api-auth-entity-storage-service",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-auth-entity-storage-service",
+	"version": "0.20.0-next.0",
+	"description": "Authentication service implementation and REST routes backed by entity storage.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api.git",
+		"directory": "packages/api-auth-entity-storage-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-auth-entity-storage-models": "0.20.0-next.0",
+		"@3sixty/api-core": "0.20.0-next.0",
+		"@3sixty/api-models": "0.20.0-next.0",
+		"@3sixty/background-task-models": "next",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/crypto": "next",
+		"@3sixty/entity": "next",
+		"@3sixty/entity-storage-models": "next",
+		"@3sixty/logging-models": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/vault-models": "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",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api/issues"
+	},
+	"homepage": "https://3sixty.global"
+}