@travetto/auth 8.0.0-alpha.9 → 8.0.0

package/README.md

@@ -2,7 +2,7 @@
 <!-- Please modify https://github.com/travetto/travetto/tree/main/module/auth/DOC.tsx and execute "npx trv doc" to rebuild -->
 # Authentication
 
-## Authentication scaffolding for the Travetto framework
+## Authentication support for the Travetto framework
 
 **Install: @travetto/auth**
 ```bash
@@ -13,7 +13,7 @@ npm install @travetto/auth
 yarn add @travetto/auth
 ```
 
-This module provides the high-level backdrop for managing security principals.  The goal of this module is to be a centralized location for various security frameworks to plug into.  The primary contributions are:
+This module provides the high-level backdrop for managing security principals. The goal of this module is to be a centralized location for various security frameworks to plug into. The primary contributions are:
    *  Standard Types
    *  Authentication Contract
    *  Authorization Contract
@@ -21,7 +21,7 @@ This module provides the high-level backdrop for managing security principals.
    *  Authorization Context
 
 ## Standard Types
-The module's goal is to be as flexible as possible.  To that end, the primary contract that this module defines, is that of the [Principal](https://github.com/travetto/travetto/tree/main/module/auth/src/types/principal.ts#L7).
+The module's goal is to be as flexible as possible. To that end, the primary contract that this module defines, is that of the [Principal](https://github.com/travetto/travetto/tree/main/module/auth/src/types/principal.ts#L7).
 
 **Code: Principal**
 ```typescript
@@ -80,7 +80,7 @@ export interface Authenticator<T = unknown, C = unknown, P extends Principal = P
 }
 ```
 
-The [Authenticator](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authenticator.ts#L9) only requires one method to be defined, and that is `authenticate`. This method receives a generic payload, and a supplemental context as an input. The interface is responsible for converting that to an authenticated principal.
+The [Authenticator](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authenticator.ts#L10) only requires one method to be defined, and that is `authenticate`. This method receives a generic payload, and a supplemental context as an input. The interface is responsible for converting that to an authenticated principal.
 
 ## Authorization Contract
 
@@ -134,14 +134,14 @@ export class AuthService {
 }
 ```
 
-The [AuthService](https://github.com/travetto/travetto/tree/main/module/auth/src/service.ts#L13) operates as the owner of the current auth state for a given "request". "Request" here implies a set of operations over a period of time, with the http request/response model being an easy point of reference.  This could also tie to a CLI operation, or any other invocation that requires some concept of authentication and authorization. 
+The [AuthService](https://github.com/travetto/travetto/tree/main/module/auth/src/service.ts#L12) operates as the owner of the current auth state for a given "request". "Request" here implies a set of operations over a period of time, with the http request/response model being an easy point of reference. This could also tie to a CLI operation, or any other invocation that requires some concept of authentication and authorization. 
 
-The service allows for storing and retrieving the active [Principal](https://github.com/travetto/travetto/tree/main/module/auth/src/types/principal.ts#L7), and/or the actively persisted auth token.  This is extremely useful for other parts of the framework that may request authenticated information (if available).  [Web Auth](https://github.com/travetto/travetto/tree/main/module/auth-web#readme "Web authentication integration support for the Travetto framework") makes heavy use of this state for enforcing endpoints when authentication is required. 
+The service allows for storing and retrieving the active [Principal](https://github.com/travetto/travetto/tree/main/module/auth/src/types/principal.ts#L7), and/or the actively persisted auth token. This is extremely useful for other parts of the framework that may request authenticated information (if available). [Web Auth](https://github.com/travetto/travetto/tree/main/module/auth-web#readme "Web authentication integration support for the Travetto framework") makes heavy use of this state for enforcing endpoints when authentication is required. 
 
 ### Login
-"Logging in" can be thought of going through the action of finding a single source that can authenticate the identity for the request credentials.  Some times there may be more than one valid source of authentication that you want to leverage, and the first one to authenticate wins. The [AuthService](https://github.com/travetto/travetto/tree/main/module/auth/src/service.ts#L13) operates in this fashion, in which a set of credentials and potential [Authenticator](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authenticator.ts#L9)s are submitted, and the service will attempt to authenticate.  
+"Logging in" can be thought of going through the action of finding a single source that can authenticate the identity for the request credentials. Some times there may be more than one valid source of authentication that you want to leverage, and the first one to authenticate wins. The [AuthService](https://github.com/travetto/travetto/tree/main/module/auth/src/service.ts#L12) operates in this fashion, in which a set of credentials and potential [Authenticator](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authenticator.ts#L10)s are submitted, and the service will attempt to authenticate. 
 
-Upon successful authentication, an optional [Authorizer](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authorizer.ts#L8) may be invoked to authorize the authenticated user.  The [Authenticator](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authenticator.ts#L9) is assumed to be only one within the system, and should be tied to the specific product you are building for.  The [Authorizer](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authorizer.ts#L8) should be assumed to have multiple sources, and are generally specific to external third parties.  All of these values are collected via the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module and will be auto-registered on startup. 
+Upon successful authentication, an optional [Authorizer](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authorizer.ts#L8) may be invoked to authorize the authenticated user. The [Authenticator](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authenticator.ts#L10) is assumed to be only one within the system, and should be tied to the specific product you are building for. The [Authorizer](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authorizer.ts#L8) should be assumed to have multiple sources, and are generally specific to external third parties. All of these values are collected via the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module and will be auto-registered on startup. 
 
 If this process is too cumbersome or restrictive, manually authenticating and authorizing is still more than permissible, and setting the principal within the service is a logical equivalent to login.
 

package/__index__.ts

@@ -1,8 +1,8 @@
-export * from './src/service.ts';
-export * from './src/context.ts';
 export * from './src/config.ts';
+export * from './src/context.ts';
+export * from './src/service.ts';
 export * from './src/types/authenticator.ts';
 export * from './src/types/authorizer.ts';
-export * from './src/types/principal.ts';
 export * from './src/types/error.ts';
-export * from './src/types/token.ts';
+export * from './src/types/principal.ts';
+export * from './src/types/token.ts';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@travetto/auth",
-  "version": "8.0.0-alpha.9",
-  "type": "module",
-  "description": "Authentication scaffolding for the Travetto framework",
+  "version": "8.0.0",
+  "private": false,
+  "description": "Authentication support for the Travetto framework",
   "keywords": [
     "authentication",
     "travetto",
@@ -11,26 +11,26 @@
   "homepage": "https://travetto.io",
   "license": "MIT",
   "author": {
-    "email": "travetto.framework@gmail.com",
-    "name": "Travetto Framework"
+    "name": "Travetto Framework",
+    "email": "travetto.framework@gmail.com"
+  },
+  "repository": {
+    "url": "git+https://github.com/travetto/travetto.git",
+    "directory": "module/auth"
   },
   "files": [
     "__index__.ts",
     "src"
   ],
+  "type": "module",
   "main": "__index__.ts",
-  "repository": {
-    "url": "git+https://github.com/travetto/travetto.git",
-    "directory": "module/auth"
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
-    "@travetto/context": "^8.0.0-alpha.9"
+    "@travetto/context": "^8.0.0"
   },
   "travetto": {
     "displayName": "Authentication"
-  },
-  "private": false,
-  "publishConfig": {
-    "access": "public"
   }
 }

package/src/config.ts

@@ -5,7 +5,6 @@ import { Ignore } from '@travetto/schema';
 
 @Config('auth')
 export class AuthConfig {
-
   maxAge: TimeSpan | number = '1h';
   rollingRenew: boolean = true;
 
@@ -16,4 +15,4 @@ export class AuthConfig {
   finalize(): void {
     this.maxAgeMs = TimeUtil.duration(this.maxAge, 'ms');
   }
-}
+}

package/src/context.ts

@@ -1,9 +1,9 @@
-import { Inject, Injectable } from '@travetto/di';
 import { type AsyncContext, AsyncContextValue } from '@travetto/context';
+import { Inject, Injectable } from '@travetto/di';
 
-import type { AuthToken } from './types/token.ts';
-import type { Principal } from './types/principal.ts';
 import type { AuthenticatorState } from './types/authenticator.ts';
+import type { Principal } from './types/principal.ts';
+import type { AuthToken } from './types/token.ts';
 
 /**
  * Provides the primary context for the authenticated state
@@ -12,7 +12,6 @@ import type { AuthenticatorState } from './types/authenticator.ts';
  */
 @Injectable()
 export class AuthContext {
-
   #principal = new AsyncContextValue<Principal>(this, { failIfUnbound: { write: true } });
   #authToken = new AsyncContextValue<AuthToken>(this, { failIfUnbound: { write: true } });
   #authState = new AsyncContextValue<AuthenticatorState>(this, { failIfUnbound: { write: true } });
@@ -71,4 +70,4 @@ export class AuthContext {
     this.#authToken.set(undefined);
     this.#authState.set(undefined);
   }
-}
+}

package/src/service.ts

@@ -1,17 +1,15 @@
-
 import { DependencyRegistryIndex, getDefaultQualifier, Inject, Injectable, PostConstruct } from '@travetto/di';
-import { toConcrete, TimeUtil } from '@travetto/runtime';
+import { TimeUtil, toConcrete } from '@travetto/runtime';
 
-import type { Principal } from './types/principal.ts';
+import type { AuthConfig } from './config.ts';
+import type { AuthContext } from './context.ts';
 import type { Authenticator } from './types/authenticator.ts';
 import type { Authorizer } from './types/authorizer.ts';
 import { AuthenticationError } from './types/error.ts';
-import type { AuthContext } from './context.ts';
-import type { AuthConfig } from './config.ts';
+import type { Principal } from './types/principal.ts';
 
 @Injectable()
 export class AuthService {
-
   @Inject()
   authContext: AuthContext;
 
@@ -60,10 +58,11 @@ export class AuthService {
           this.authContext.authenticatorState = await authenticator.getState(context);
         }
 
-        if (!principal) { // Multi-step login process
+        if (!principal) {
+          // Multi-step login process
           return;
         }
-        return this.authContext.principal = (await this.authorizer?.authorize(principal)) ?? principal;
+        return (this.authContext.principal = (await this.authorizer?.authorize(principal)) ?? principal);
       } catch (error) {
         if (!(error instanceof Error)) {
           throw error;
@@ -94,10 +93,12 @@ export class AuthService {
 
     principal.issuedAt ??= new Date();
 
-    if (principal.expiresAt && this.config.maxAgeMs && this.config.rollingRenew) { // Session behavior
+    if (principal.expiresAt && this.config.maxAgeMs && this.config.rollingRenew) {
+      // Session behavior
       const end = principal.expiresAt.getTime();
       const midPoint = end - this.config.maxAgeMs / 2;
-      if (Date.now() > midPoint) { // If we are past the half way mark, renew the token
+      if (Date.now() > midPoint) {
+        // If we are past the half way mark, renew the token
         principal.issuedAt = new Date();
         principal.expiresAt = TimeUtil.fromNow(this.config.maxAgeMs); // This will trigger a re-send
       }
@@ -108,9 +109,9 @@ export class AuthService {
    * Enforce expiry, invalidating the principal if expired
    */
   enforceExpiry(principal?: Principal): Principal | undefined {
-    if (principal && principal.expiresAt && principal.expiresAt.getTime() < Date.now()) {
+    if (principal?.expiresAt && principal.expiresAt.getTime() < Date.now()) {
       return undefined;
     }
     return principal;
   }
-}
+}

package/src/types/authenticator.ts

@@ -1,4 +1,5 @@
 import type { AnyMap } from '@travetto/runtime';
+
 import type { Principal } from './principal.ts';
 
 /**
@@ -6,7 +7,7 @@ import type { Principal } from './principal.ts';
  *
  * @concrete
  */
-export interface AuthenticatorState extends AnyMap { }
+export interface AuthenticatorState extends AnyMap {}
 
 /**
  * Supports validation payload of type T into an authenticated principal

package/src/types/error.ts

@@ -1,6 +1,5 @@
-import { RuntimeError, type ErrorCategory } from '@travetto/runtime';
+import { type ErrorCategory, RuntimeError } from '@travetto/runtime';
 
 export class AuthenticationError<T = Record<string, unknown> | undefined> extends RuntimeError<T> {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   static defaultCategory = 'authentication' as ErrorCategory;
-}
+}

package/src/types/principal.ts

@@ -33,4 +33,4 @@ export interface Principal<D = AnyMap> {
    * List of all provided permissions
    */
   readonly permissions?: string[];
-}
+}

package/src/types/token.ts

@@ -5,4 +5,4 @@
 export interface AuthToken {
   value: string;
   type: string;
-};
+}