@travetto/auth-web 7.0.0-rc.1 → 7.0.0-rc.3

package/README.md

@@ -149,23 +149,23 @@ export class JWTPrincipalCodec implements PrincipalCodec {
   postConstruct(): void {
     this.#verifier = createVerifier()
       .setSigningAlgorithm(this.#algorithm)
-      .withKeyResolver((kid, cb) => {
-        const rec = this.config.keyMap[kid];
-        return cb(rec ? null : new AuthenticationError('Invalid'), rec.key);
+      .withKeyResolver((keyId, callback) => {
+        const entry = this.config.keyMap[keyId];
+        return callback(entry ? null : new AuthenticationError('Invalid'), entry.key);
       });
   }
 
   async verify(token: string): Promise<Principal> {
     try {
-      const jwt: Jwt & { body: { core: Principal } } = await new Promise((res, rej) =>
-        this.#verifier.verify(token, (err, v) => err ? rej(err) : res(castTo(v)))
+      const jwt: Jwt & { body: { core: Principal } } = await new Promise((resolve, reject) =>
+        this.#verifier.verify(token, (error, verified) => error ? reject(error) : resolve(castTo(verified)))
       );
       return jwt.body.core;
-    } catch (err) {
-      if (err instanceof Error && err.name.startsWith('Jwt')) {
-        throw new AuthenticationError(err.message, { category: 'permissions' });
+    } catch (error) {
+      if (error instanceof Error && error.name.startsWith('Jwt')) {
+        throw new AuthenticationError(error.message, { category: 'permissions' });
       }
-      throw err;
+      throw error;
     }
   }
 
@@ -182,8 +182,8 @@ export class JWTPrincipalCodec implements PrincipalCodec {
   }
 
   async create(value: Principal, keyId: string = 'default'): Promise<string> {
-    const keyRec = this.config.keyMap[keyId];
-    if (!keyRec) {
+    const entry = this.config.keyMap[keyId];
+    if (!entry) {
       throw new AppError('Requested unknown key for signing');
     }
     const jwt = create({}, '-')
@@ -193,8 +193,8 @@ export class JWTPrincipalCodec implements PrincipalCodec {
       .setIssuer(value.issuer!)
       .setJti(value.sessionId!)
       .setSubject(value.id)
-      .setHeader('kid', keyRec.id)
-      .setSigningKey(keyRec.key)
+      .setHeader('kid', entry.id)
+      .setSigningKey(entry.key)
       .setSigningAlgorithm(this.#algorithm);
     return jwt.toString();
   }
@@ -231,9 +231,9 @@ export class CustomCodec implements PrincipalCodec {
   decode(request: WebRequest): Promise<Principal | undefined> | Principal | undefined {
     const [userId, sig] = request.headers.get('USER_ID')?.split(':') ?? [];
     if (userId && sig === BinaryUtil.hash(userId + this.secret)) {
-      let p: Principal | undefined;
+      let principal: Principal | undefined;
       // Lookup user from db, remote system, etc.,
-      return p;
+      return principal;
     }
     return;
   }
@@ -287,7 +287,7 @@ export class SampleAuth {
 }
 ```
 
-[@Authenticated](https://github.com/travetto/travetto/tree/main/module/auth-web/src/decorator.ts#L29) and [@Unauthenticated](https://github.com/travetto/travetto/tree/main/module/auth-web/src/decorator.ts#L45) will simply enforce whether or not a user is logged in and throw the appropriate error messages as needed. Additionally, the [Principal](https://github.com/travetto/travetto/tree/main/module/auth/src/types/principal.ts#L7) is accessible as a resource that can be exposed as a [@ContextParam](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/param.ts#L66) on an [@Injectable](https://github.com/travetto/travetto/tree/main/module/di/src/decorator.ts#L15) class.
+[@Authenticated](https://github.com/travetto/travetto/tree/main/module/auth-web/src/decorator.ts#L29) and [@Unauthenticated](https://github.com/travetto/travetto/tree/main/module/auth-web/src/decorator.ts#L45) will simply enforce whether or not a user is logged in and throw the appropriate error messages as needed. Additionally, the [Principal](https://github.com/travetto/travetto/tree/main/module/auth/src/types/principal.ts#L7) is accessible as a resource that can be exposed as a [@ContextParam](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/param.ts#L64) on an [@Injectable](https://github.com/travetto/travetto/tree/main/module/di/src/decorator.ts#L15) class.
 
 ## Multi-Step Login
 When authenticating, with a multi-step process, it is useful to share information between steps.  The `authenticatorState` of [AuthContext](https://github.com/travetto/travetto/tree/main/module/auth/src/context.ts#L14) field is intended to be a location in which that information is persisted. Currently only [passport](http://passportjs.org) support is included, when dealing with multi-step logins. This information can also be injected into a web endpoint method, using the [AuthenticatorState](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authenticator.ts#L9) type;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/auth-web",
-  "version": "7.0.0-rc.1",
+  "version": "7.0.0-rc.3",
   "description": "Web authentication integration support for the Travetto framework",
   "keywords": [
     "authentication",
@@ -26,13 +26,13 @@
     "directory": "module/auth-web"
   },
   "dependencies": {
-    "@travetto/auth": "^7.0.0-rc.0",
-    "@travetto/config": "^7.0.0-rc.0",
-    "@travetto/web": "^7.0.0-rc.1",
+    "@travetto/auth": "^7.0.0-rc.2",
+    "@travetto/config": "^7.0.0-rc.2",
+    "@travetto/web": "^7.0.0-rc.3",
     "njwt": "^2.0.1"
   },
   "peerDependencies": {
-    "@travetto/test": "^7.0.0-rc.0"
+    "@travetto/test": "^7.0.0-rc.2"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/codec.ts

@@ -29,23 +29,23 @@ export class JWTPrincipalCodec implements PrincipalCodec {
   postConstruct(): void {
     this.#verifier = createVerifier()
       .setSigningAlgorithm(this.#algorithm)
-      .withKeyResolver((kid, cb) => {
-        const rec = this.config.keyMap[kid];
-        return cb(rec ? null : new AuthenticationError('Invalid'), rec.key);
+      .withKeyResolver((keyId, callback) => {
+        const entry = this.config.keyMap[keyId];
+        return callback(entry ? null : new AuthenticationError('Invalid'), entry.key);
       });
   }
 
   async verify(token: string): Promise<Principal> {
     try {
-      const jwt: Jwt & { body: { core: Principal } } = await new Promise((res, rej) =>
-        this.#verifier.verify(token, (err, v) => err ? rej(err) : res(castTo(v)))
+      const jwt: Jwt & { body: { core: Principal } } = await new Promise((resolve, reject) =>
+        this.#verifier.verify(token, (error, verified) => error ? reject(error) : resolve(castTo(verified)))
       );
       return jwt.body.core;
-    } catch (err) {
-      if (err instanceof Error && err.name.startsWith('Jwt')) {
-        throw new AuthenticationError(err.message, { category: 'permissions' });
+    } catch (error) {
+      if (error instanceof Error && error.name.startsWith('Jwt')) {
+        throw new AuthenticationError(error.message, { category: 'permissions' });
       }
-      throw err;
+      throw error;
     }
   }
 
@@ -62,8 +62,8 @@ export class JWTPrincipalCodec implements PrincipalCodec {
   }
 
   async create(value: Principal, keyId: string = 'default'): Promise<string> {
-    const keyRec = this.config.keyMap[keyId];
-    if (!keyRec) {
+    const entry = this.config.keyMap[keyId];
+    if (!entry) {
       throw new AppError('Requested unknown key for signing');
     }
     const jwt = create({}, '-')
@@ -73,8 +73,8 @@ export class JWTPrincipalCodec implements PrincipalCodec {
       .setIssuer(value.issuer!)
       .setJti(value.sessionId!)
       .setSubject(value.id)
-      .setHeader('kid', keyRec.id)
-      .setSigningKey(keyRec.key)
+      .setHeader('kid', entry.id)
+      .setSigningKey(entry.key)
       .setSigningAlgorithm(this.#algorithm);
     return jwt.toString();
   }

package/src/config.ts

@@ -2,7 +2,7 @@ import { Config } from '@travetto/config';
 import { Runtime, AppError, BinaryUtil } from '@travetto/runtime';
 import { Ignore, Secret } from '@travetto/schema';
 
-type KeyRec = { key: string, id: string };
+type KeyEntry = { key: string, id: string };
 
 @Config('web.auth')
 export class WebAuthConfig {
@@ -15,7 +15,7 @@ export class WebAuthConfig {
   @Secret()
   signingKey?: string | string[];
   @Ignore()
-  keyMap: Record<string, KeyRec> & { default?: KeyRec } = {};
+  keyMap: Record<string, KeyEntry> & { default?: KeyEntry } = {};
 
   postConstruct(): void {
     if (!this.signingKey && Runtime.production) {
@@ -24,7 +24,7 @@ export class WebAuthConfig {
     this.signingKey ??= 'dummy';
 
     const all = [this.signingKey].flat().map(key => ({ key, id: BinaryUtil.hash(key, 8) }));
-    this.keyMap = Object.fromEntries(all.map(k => [k.id, k]));
+    this.keyMap = Object.fromEntries(all.map(entry => [entry.id, entry]));
     this.keyMap.default = all[0];
   }
 }

package/src/interceptors/context.ts

@@ -7,7 +7,7 @@ import { Required } from '@travetto/schema';
 import { CommonPrincipalCodecSymbol, PrincipalCodec } from '../types.ts';
 import { WebAuthConfig } from '../config.ts';
 
-const toDate = (v: string | Date | undefined): Date | undefined => (typeof v === 'string') ? new Date(v) : v;
+const toDate = (value: string | Date | undefined): Date | undefined => (typeof value === 'string') ? new Date(value) : value;
 
 /**
  * Auth Context interceptor

package/src/interceptors/verify.ts

@@ -7,9 +7,9 @@ import { AuthenticationError, AuthContext } from '@travetto/auth';
 
 import { AuthContextInterceptor } from './context.ts';
 
-function matchPermissionSet(rule: string[], perms: Set<string>): boolean {
-  for (const el of rule) {
-    if (!perms.has(el)) {
+function matchPermissionSet(rule: string[], permissions: Set<string>): boolean {
+  for (const permission of rule) {
+    if (!permissions.has(permission)) {
       return false;
     }
   }
@@ -54,7 +54,7 @@ export class AuthVerifyInterceptor implements WebInterceptor<WebAuthVerifyConfig
 
   finalizeConfig({ config }: WebInterceptorContext<WebAuthVerifyConfig>): WebAuthVerifyConfig {
     config.matcher = Util.allowDeny<string[], [Set<string>]>(config.permissions ?? [],
-      x => x.split('|'),
+      item => item.split('|'),
       matchPermissionSet,
     );
     return config;