@twin.org/api-auth-entity-storage-service 0.0.2-next.9 → 0.0.3-next.10

package/docs/reference/classes/TokenHelper.md

@@ -12,11 +12,19 @@ Helper class for token operations.
 
 `TokenHelper`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### createToken()
 
-> `static` **createToken**(`vaultConnector`, `signingKeyName`, `subject`, `ttlMinutes`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
+> `static` **createToken**(`vaultConnector`, `signingKeyName`, `userIdentity`, `organizationIdentity`, `tenantId`, `ttlMinutes`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
 
 Create a new token.
 
@@ -34,12 +42,24 @@ The vault connector.
 
 The signing key name.
 
-##### subject
+##### userIdentity
 
 `string`
 
 The subject for the token.
 
+##### organizationIdentity
+
+The organization for the token.
+
+`string` | `undefined`
+
+##### tenantId
+
+The tenant id for the token.
+
+`string` | `undefined`
+
 ##### ttlMinutes
 
 `number`
@@ -56,7 +76,7 @@ The new token and its expiry date.
 
 ### verify()
 
-> `static` **verify**(`vaultConnector`, `signingKeyName`, `token`): `Promise`\<\{ `header`: `IJwtHeader`; `payload`: `IJwtPayload`; \}\>
+> `static` **verify**(`vaultConnector`, `signingKeyName`, `token`): `Promise`\<\{ `header`: `JWTHeaderParameters`; `payload`: `JWTPayload`; \}\>
 
 Verify the token.
 
@@ -78,11 +98,11 @@ The signing key name.
 
 The token to verify.
 
-`undefined` | `string`
+`string` | `undefined`
 
 #### Returns
 
-`Promise`\<\{ `header`: `IJwtHeader`; `payload`: `IJwtPayload`; \}\>
+`Promise`\<\{ `header`: `JWTHeaderParameters`; `payload`: `JWTPayload`; \}\>
 
 The verified details.
 
@@ -94,7 +114,7 @@ UnauthorizedError if the token is missing, invalid or expired.
 
 ### extractTokenFromHeaders()
 
-> `static` **extractTokenFromHeaders**(`headers?`, `cookieName?`): `undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
+> `static` **extractTokenFromHeaders**(`headers?`, `cookieName?`): \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \} \| `undefined`
 
 Extract the auth token from the headers, either from the authorization header or the cookie header.
 
@@ -114,6 +134,6 @@ The name of the cookie to extract the token from.
 
 #### Returns
 
-`undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
+\{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \} \| `undefined`
 
 The token if found.

package/locales/en.json

@@ -2,26 +2,26 @@
 	"error": {
 		"entityStorageAuthenticationService": {
 			"loginFailed": "Login failed",
-			"refreshFailed": "Refresh failed",
 			"userNotFound": "The user with the specified e-mail could not be found",
 			"passwordMismatch": "The password does not match the user's password"
 		},
 		"entityStorageAuthenticationAdminService": {
 			"userExists": "The user with the specified e-mail already exists",
-			"createFailed": "Creating the user failed",
-			"removeFailed": "Removing the user failed",
+			"createUserFailed": "Creating the user failed",
+			"removeUserFailed": "Removing the user failed",
 			"updatePasswordFailed": "Updating the user's password failed",
 			"passwordTooShort": "The password is too short, it must be at least {minLength} characters long",
 			"userNotFound": "The user with the specified e-mail could not be found \"{notFoundId}\"",
 			"currentPasswordMismatch": "The current password is incorrect"
 		},
-		"entityStorageAuthenticationProcessor": {
-			"initializeFailed": "The JSON Web token authentication processor could not be initialized"
-		},
 		"tokenHelper": {
 			"missing": "The JSON Web token could not be found in the authorization header",
 			"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"
+		},
+		"authHeaderProcessor": {
+			"tenantIdMismatch": "The tenant ID in the token does not match the tenant ID in the context"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-service",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.10",
 	"description": "Auth Entity Storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,10 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-models": "0.0.2-next.9",
-		"@twin.org/api-core": "0.0.2-next.9",
-		"@twin.org/api-models": "0.0.2-next.9",
+		"@twin.org/api-auth-entity-storage-models": "0.0.3-next.10",
+		"@twin.org/api-core": "0.0.3-next.10",
+		"@twin.org/api-models": "0.0.3-next.10",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/entity": "next",
@@ -26,21 +27,38 @@
 		"@twin.org/vault-models": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"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/twinfoundation/api/issues"
+	},
+	"homepage": "https://twindev.org"
 }