@travetto/auth 6.0.0-rc.0 → 6.0.0-rc.1

package/README.md

@@ -82,9 +82,6 @@ export interface Authenticator<T = unknown, C = unknown, P extends Principal = P
 
 The [Authenticator Contract](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authenticator.ts#L14) 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.
 
-### Example
-The [JWT](https://github.com/travetto/travetto/tree/main/module/jwt#readme "JSON Web Token implementation") module is a good example of an authenticator. This is a common use case for simple internal auth.
-
 ## Authorization Contract
 
 **Code: Authorizer Contract**
@@ -153,18 +150,8 @@ When working with framework's authentication, the authenticated information is e
 
 **Code: Auth Context Outline**
 ```typescript
-type AuthContextShape = {
-  principal?: Principal;
-  authToken?: AuthToken;
-  authenticatorState?: AuthenticatorState;
-};
-@Injectable()
 export class AuthContext {
   @Inject()
-  /**
-   * Get the principal, if set
-   */
-  get principal(): Principal | undefined;
   /**
    * Set principal
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/auth",
-  "version": "6.0.0-rc.0",
+  "version": "6.0.0-rc.1",
   "description": "Authentication scaffolding for the Travetto framework",
   "keywords": [
     "authentication",
@@ -23,7 +23,7 @@
     "directory": "module/auth"
   },
   "dependencies": {
-    "@travetto/context": "^6.0.0-rc.0"
+    "@travetto/context": "^6.0.0-rc.1"
   },
   "travetto": {
     "displayName": "Authentication"

package/src/context.ts

@@ -6,68 +6,62 @@ import { AuthToken } from './types/token';
 import { Principal } from './types/principal';
 import { AuthenticatorState } from './types/authenticator';
 
-type AuthContextShape = {
-  principal?: Principal;
-  authToken?: AuthToken;
-  authenticatorState?: AuthenticatorState;
-};
-
+/**
+ * Provides the primary context for the authenticated state
+ *
+ *
+ * Will silently fail on reads, but will error on writes if the context is not established.
+ */
 @Injectable()
 export class AuthContext {
 
-  #value = new AsyncContextValue<AuthContextShape>(this);
+  #principal = new AsyncContextValue<Principal>(this, { failIfUnbound: { write: true } });
+  #authToken = new AsyncContextValue<AuthToken>(this, { failIfUnbound: { write: true } });
+  #authState = new AsyncContextValue<AuthenticatorState>(this, { failIfUnbound: { write: true } });
 
   @Inject()
   context: AsyncContext;
 
-  /**
-   * Initialize context
-   * @private
-   */
-  init(): void {
-    this.#value.set({});
-  }
-
   /**
    * Get the principal, if set
    */
   get principal(): Principal | undefined {
-    return this.#value.get()?.principal;
+    return this.#principal.get();
   }
 
   /**
    * Set principal
    */
   set principal(p: Principal | undefined) {
-    this.#value.get()!.principal = p;
+    this.#principal.set(p);
   }
 
   /**
    * Get the authentication token, if it exists
    */
   get authToken(): AuthToken | undefined {
-    return this.#value.get()?.authToken;
+    return this.#authToken.get();
   }
 
   /**
    * Set/overwrite the user's authentication token
    */
   set authToken(token: AuthToken | undefined) {
-    this.#value.get()!.authToken = token;
+    this.#authToken.set(token);
   }
 
   /**
    * Get the authenticator state, if it exists
    */
   get authenticatorState(): AuthenticatorState | undefined {
-    return this.#value.get()?.authenticatorState;
+    return this.#authState.get();
   }
 
   /**
    * Set/overwrite the authenticator state
    */
   set authenticatorState(state: AuthenticatorState | undefined) {
-    this.#value.get()!.authenticatorState = state;
+    this.#authState.set(state);
   }
 
   /**
@@ -75,6 +69,8 @@ export class AuthContext {
    * @private
    */
   async clear(): Promise<void> {
-    this.#value.set(undefined);
+    this.#principal.set(undefined);
+    this.#authToken.set(undefined);
+    this.#authState.set(undefined);
   }
 }

package/src/types/principal.ts

@@ -2,7 +2,7 @@ import { AnyMap } from '@travetto/runtime';
 
 /**
  * A user principal, including permissions and details
- * @augments `@travetto/rest:Context`
+ * @augments `@travetto/rest:ContextParam`
  * @concrete ../internal/types#PrincipalTarget
  */
 export interface Principal<D = AnyMap> {

package/src/types/token.ts

@@ -1 +1,7 @@
-export type AuthToken = { value: string, type: string };
+/**
+ * Represents the authenticated token used, allows for reuse on subsequent calls
+ */
+export interface AuthToken {
+  value: string;
+  type: string;
+};