@travetto/auth 3.0.2-rc.1 → 3.0.3

package/README.md

@@ -1,6 +1,7 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/auth/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- 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
 
 **Install: @travetto/auth**
@@ -13,12 +14,10 @@ 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:
-
-   
    *  Standard Types
    *  Authentication Contract
    *  Authorization Contract
-   *  Common security-related utilities for    
+   *  Common security-related utilities for
       *  Checking permissions
       *  Generating passwords
 
@@ -102,15 +101,14 @@ export interface Authorizer<P extends Principal = Principal> {
 }
 ```
 
-Authorizers are generally seen as a secondary step post-authentication. Authentication acts as a very basic form of authorization, assuming the principal store is owned by the application.
+Authorizers are generally seen as a secondary step post-authentication. Authentication acts as a very basic form of authorization, assuming the principal store is owned by the application. 
 
 The [Authorizer](https://github.com/travetto/travetto/tree/main/module/auth/src/types/authorizer.ts#L8) only requires one method to be defined, and that is `authorizer`. This method receives an authenticated principal as an input, and is responsible for converting that to an authorized principal.
 
 ### Example
-The [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") extension is a good example of an authenticator. This is a common use case for simple internal auth.
+The [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") extension is a good example of an authenticator. This is a common use case for simple internal auth. 
 
 Overall, the structure is simple, but drives home the primary use cases of the framework. The goals are:
-   
    *  Be able to identify a user uniquely
    *  To have a reference to a user's set of permissions
    *  To have access to the principal
@@ -155,17 +153,13 @@ export class AuthUtil {
 }
 ```
 
-`roleMatcher` is probably the only functionality that needs to be explained.  The function extends the core allow/deny matcher functionality from [Base](https://github.com/travetto/travetto/tree/main/module/base#readme "Environment config and common utilities for travetto applications.")'s Util class.  
+`roleMatcher` is probably the only functionality that needs to be explained.  The function extends the core allow/deny matcher functionality from [Base](https://github.com/travetto/travetto/tree/main/module/base#readme "Environment config and common utilities for travetto applications.")'s Util class. 
 
 An example of role checks could be:
-
-   
    *  Admin
    *  !Editor
    *  Owner+Author
-
 The code would check the list in order, which would result in the following logic:
-   
    *  If the user is an admin, always allow
    *  If the user has the editor role, deny
    *  If the user is both an owner and an author allow

package/package.json

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