@travetto/auth 3.0.0-rc.2 → 3.0.0-rc.21

package/README.md

@@ -1,11 +1,15 @@
 <!-- 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.ts and execute "npx trv doc" to rebuild -->
 # Authentication
-## Authentication scaffolding for the travetto framework
+## Authentication scaffolding for the Travetto framework
 
 **Install: @travetto/auth**
 ```bash
 npm install @travetto/auth
+
+# or
+
+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:
@@ -62,6 +66,12 @@ As referenced above, a [Principal Structure](https://github.com/travetto/travett
 **Code: Authenticator**
 ```typescript
 export interface Authenticator<T = unknown, P extends Principal = Principal, C = unknown> {
+  /**
+   * Allows for the authenticator to be initialized if needed
+   * @param ctx
+   */
+  initialize?(ctx: C): Promise<void>;
+
   /**
    * Verify the payload, ensuring the payload is correctly identified.
    *
@@ -110,8 +120,8 @@ The [AuthUtil](https://github.com/travetto/travetto/tree/main/module/auth/src/ut
 
 **Code: Auth util structure**
 ```typescript
-import * as crypto from 'crypto';
-import * as util from 'util';
+import crypto from 'crypto';
+import util from 'util';
 import { AppError, Util } from '@travetto/base';
 const pbkdf2 = util.promisify(crypto.pbkdf2);
 /**
@@ -123,7 +133,7 @@ export class AuthUtil {
    *
    * @param roles Roles to build matcher for
    */
-  static roleMatcher(roles: string[]): (perms: Set<string>) => boolean ;
+  static roleMatcher(roles: string[]): (perms: Set<string>) => boolean;
   /**
    * Generate a hash for a given value
    *
@@ -133,7 +143,7 @@ export class AuthUtil {
    * @param keylen Length of hash
    * @param digest Digest method
    */
-  static generateHash(value: string, salt: string, iterations = 25000, keylen = 256, digest = 'sha256'): Promise<string> ;
+  static generateHash(value: string, salt: string, iterations = 25000, keylen = 256, digest = 'sha256'): Promise<string>;
   /**
    * Generate a salted password, with the ability to validate the password
    *
@@ -141,11 +151,11 @@ export class AuthUtil {
    * @param salt Salt value, or if a number, length of salt
    * @param validator Optional function to validate your password
    */
-  static async generatePassword(password: string, salt: number | string = 32): Promise<{ salt: string, hash: string }> ;
+  static async generatePassword(password: string, salt: number | string = 32): Promise<{ salt: string, hash: string }>;
 }
 ```
 
-`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 "Application phase management, 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:
 

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@travetto/auth",
-  "displayName": "Authentication",
-  "version": "3.0.0-rc.2",
-  "description": "Authentication scaffolding for the travetto framework",
+  "version": "3.0.0-rc.21",
+  "description": "Authentication scaffolding for the Travetto framework",
   "keywords": [
     "authentication",
     "travetto",
@@ -15,16 +14,19 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/auth"
   },
   "dependencies": {
-    "@travetto/base": "^3.0.0-rc.2"
+    "@travetto/base": "^3.0.0-rc.21"
+  },
+  "travetto": {
+    "displayName": "Authentication"
   },
   "private": false,
   "publishConfig": {

package/src/types/authenticator.ts

@@ -6,6 +6,12 @@ import { Principal } from './principal';
  * @concrete ../internal/types:AuthenticatorTarget
  */
 export interface Authenticator<T = unknown, P extends Principal = Principal, C = unknown> {
+  /**
+   * Allows for the authenticator to be initialized if needed
+   * @param ctx
+   */
+  initialize?(ctx: C): Promise<void>;
+
   /**
    * Verify the payload, ensuring the payload is correctly identified.
    *

package/src/types/principal.ts

@@ -2,7 +2,7 @@
  * A user principal, including permissions and details
  *
  * @concrete ../internal/types:PrincipalTarget
- * @augments `@trv:rest/Context`
+ * @augments `@travetto/rest:Context`
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface Principal<D = { [key: string]: any }> {

package/src/util.ts

@@ -1,5 +1,5 @@
-import * as crypto from 'crypto';
-import * as util from 'util';
+import crypto from 'crypto';
+import util from 'util';
 
 import { AppError, Util } from '@travetto/base';