@twin.org/api-auth-entity-storage-service 0.0.1-next.5 → 0.0.1-next.7

package/dist/cjs/index.cjs

@@ -120,12 +120,13 @@ class TokenHelper {
      * @returns The token if found.
      */
     static extractTokenFromHeaders(headers, cookieName) {
-        const cookiesHeader = headers?.cookie;
-        let token;
-        let location;
-        if (core.Is.string(headers?.authorization) && headers.authorization.startsWith("Bearer ")) {
-            token = headers.authorization.slice(7).trim();
-            location = "authorization";
+        const authHeader = headers?.[web.HeaderTypes.Authorization];
+        const cookiesHeader = headers?.[web.HeaderTypes.Cookie];
+        if (core.Is.string(authHeader) && authHeader.startsWith("Bearer ")) {
+            return {
+                token: authHeader.slice(7).trim(),
+                location: "authorization"
+            };
         }
         else if (core.Is.notEmpty(cookiesHeader) && core.Is.stringValue(cookieName)) {
             const cookies = core.Is.arrayValue(cookiesHeader) ? cookiesHeader : [cookiesHeader];
@@ -136,17 +137,14 @@ class TokenHelper {
                         .map(c => c.trim())
                         .find(c => c.startsWith(cookieName));
                     if (core.Is.stringValue(accessTokenCookie)) {
-                        token = accessTokenCookie.slice(cookieName.length + 1).trim();
-                        location = "cookie";
-                        break;
+                        return {
+                            token: accessTokenCookie.slice(cookieName.length + 1).trim(),
+                            location: "cookie"
+                        };
                     }
                 }
             }
         }
-        return {
-            token,
-            location
-        };
     }
 }
 
@@ -218,10 +216,10 @@ class AuthHeaderProcessor {
         if (!core.Is.empty(route) && !(route.skipAuth ?? false)) {
             try {
                 const tokenAndLocation = TokenHelper.extractTokenFromHeaders(request.headers, this._cookieName);
-                const headerAndPayload = await TokenHelper.verify(this._vaultConnector, `${this._nodeIdentity}/${this._signingKeyName}`, tokenAndLocation.token);
+                const headerAndPayload = await TokenHelper.verify(this._vaultConnector, `${this._nodeIdentity}/${this._signingKeyName}`, tokenAndLocation?.token);
                 requestIdentity.userIdentity = headerAndPayload.payload?.sub;
-                processorState.authToken = tokenAndLocation.token;
-                processorState.authTokenLocation = tokenAndLocation.location;
+                processorState.authToken = tokenAndLocation?.token;
+                processorState.authTokenLocation = tokenAndLocation?.location;
             }
             catch (err) {
                 const error = core.BaseError.fromError(err);

package/dist/esm/index.mjs

@@ -2,7 +2,7 @@ import { property, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin
 import { HttpErrorHelper } from '@twin.org/api-models';
 import { Is, UnauthorizedError, Guards, BaseError, ComponentFactory, Converter, GeneralError } from '@twin.org/core';
 import { VaultConnectorFactory } from '@twin.org/vault-models';
-import { Jwt, JwtAlgorithms, HttpStatusCode } from '@twin.org/web';
+import { Jwt, JwtAlgorithms, HeaderTypes, HttpStatusCode } from '@twin.org/web';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 import { Blake2b } from '@twin.org/crypto';
 
@@ -118,12 +118,13 @@ class TokenHelper {
      * @returns The token if found.
      */
     static extractTokenFromHeaders(headers, cookieName) {
-        const cookiesHeader = headers?.cookie;
-        let token;
-        let location;
-        if (Is.string(headers?.authorization) && headers.authorization.startsWith("Bearer ")) {
-            token = headers.authorization.slice(7).trim();
-            location = "authorization";
+        const authHeader = headers?.[HeaderTypes.Authorization];
+        const cookiesHeader = headers?.[HeaderTypes.Cookie];
+        if (Is.string(authHeader) && authHeader.startsWith("Bearer ")) {
+            return {
+                token: authHeader.slice(7).trim(),
+                location: "authorization"
+            };
         }
         else if (Is.notEmpty(cookiesHeader) && Is.stringValue(cookieName)) {
             const cookies = Is.arrayValue(cookiesHeader) ? cookiesHeader : [cookiesHeader];
@@ -134,17 +135,14 @@ class TokenHelper {
                         .map(c => c.trim())
                         .find(c => c.startsWith(cookieName));
                     if (Is.stringValue(accessTokenCookie)) {
-                        token = accessTokenCookie.slice(cookieName.length + 1).trim();
-                        location = "cookie";
-                        break;
+                        return {
+                            token: accessTokenCookie.slice(cookieName.length + 1).trim(),
+                            location: "cookie"
+                        };
                     }
                 }
             }
         }
-        return {
-            token,
-            location
-        };
     }
 }
 
@@ -216,10 +214,10 @@ class AuthHeaderProcessor {
         if (!Is.empty(route) && !(route.skipAuth ?? false)) {
             try {
                 const tokenAndLocation = TokenHelper.extractTokenFromHeaders(request.headers, this._cookieName);
-                const headerAndPayload = await TokenHelper.verify(this._vaultConnector, `${this._nodeIdentity}/${this._signingKeyName}`, tokenAndLocation.token);
+                const headerAndPayload = await TokenHelper.verify(this._vaultConnector, `${this._nodeIdentity}/${this._signingKeyName}`, tokenAndLocation?.token);
                 requestIdentity.userIdentity = headerAndPayload.payload?.sub;
-                processorState.authToken = tokenAndLocation.token;
-                processorState.authTokenLocation = tokenAndLocation.location;
+                processorState.authToken = tokenAndLocation?.token;
+                processorState.authTokenLocation = tokenAndLocation?.location;
             }
             catch (err) {
                 const error = BaseError.fromError(err);

package/dist/types/utils/tokenHelper.d.ts

@@ -35,7 +35,7 @@ export declare class TokenHelper {
      * @returns The token if found.
      */
     static extractTokenFromHeaders(headers?: IHttpHeaders, cookieName?: string): {
-        token: string | undefined;
-        location: "authorization" | "cookie" | undefined;
-    };
+        token: string;
+        location: "authorization" | "cookie";
+    } | undefined;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-auth-entity-storage-service - Changelog
 
-## v0.0.1-next.5
+## v0.0.1-next.7
 
 - Initial Release

package/docs/reference/classes/TokenHelper.md

@@ -96,7 +96,7 @@ UnauthorizedError if the token is missing, invalid or expired.
 
 ### extractTokenFromHeaders()
 
-> `static` **extractTokenFromHeaders**(`headers`?, `cookieName`?): `object`
+> `static` **extractTokenFromHeaders**(`headers`?, `cookieName`?): `undefined` \| `object`
 
 Extract the auth token from the headers, either from the authorization header or the cookie header.
 
@@ -112,14 +112,6 @@ The name of the cookie to extract the token from.
 
 #### Returns
 
-`object`
+`undefined` \| `object`
 
 The token if found.
-
-##### token
-
-> **token**: `undefined` \| `string`
-
-##### location
-
-> **location**: `undefined` \| `"authorization"` \| `"cookie"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-service",
-	"version": "0.0.1-next.5",
+	"version": "0.0.1-next.7",
 	"description": "Auth Entity Storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-models": "0.0.1-next.5",
-		"@twin.org/api-core": "0.0.1-next.5",
-		"@twin.org/api-models": "0.0.1-next.5",
+		"@twin.org/api-auth-entity-storage-models": "0.0.1-next.7",
+		"@twin.org/api-core": "0.0.1-next.7",
+		"@twin.org/api-models": "0.0.1-next.7",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/entity": "next",