@travetto/auth-model 8.0.0-alpha.22 → 8.0.0-alpha.24

package/README.md

@@ -15,7 +15,7 @@ yarn add @travetto/auth-model
 
 This module supports the integration between the [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication support for the Travetto framework") module and the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations."). 
 
-The asset module requires a [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11)-model to provide functionality for reading and storing user information. You can use any existing providers to serve as your [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11), or you can roll your own.
+The asset module requires a [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L10)-model to provide functionality for reading and storing user information. You can use any existing providers to serve as your [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L10), or you can roll your own.
 
 **Install: provider**
 ```bash
@@ -25,7 +25,7 @@ npm install @travetto/model-{provider}
 
 yarn add @travetto/model-{provider}
 ```
-Currently, the following are packages that provide [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11):
+Currently, the following are packages that provide [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L10):
    *  [DynamoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-dynamodb#readme "DynamoDB backing for the travetto model module.") - @travetto/model-dynamodb
    *  [Elasticsearch Model Source](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch#readme "Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.") - @travetto/model-elasticsearch
    *  [Firestore Model Support](https://github.com/travetto/travetto/tree/main/module/model-firestore#readme "Firestore backing for the travetto model module.") - @travetto/model-firestore
@@ -38,7 +38,7 @@ Currently, the following are packages that provide [CRUD](https://github.com/tra
    *  [Memory Model Support](https://github.com/travetto/travetto/tree/main/module/model-memory#readme "Memory backing for the travetto model module.") - @travetto/model-memory
    *  [File Model Support](https://github.com/travetto/travetto/tree/main/module/model-file#readme "File system backing for the travetto model module.") - @travetto/model-file
 
-The module itself is fairly straightforward, and truly the only integration point for this module to work is defined at the model level.  The contract for authentication is established in code as providing translation to and from a [RegisteredPrincipal](https://github.com/travetto/travetto/tree/main/module/auth-model/src/model.ts#L11). 
+The module itself is fairly straightforward, and truly the only integration point for this module to work is defined at the model level. The contract for authentication is established in code as providing translation to and from a [RegisteredPrincipal](https://github.com/travetto/travetto/tree/main/module/auth-model/src/model.ts#L11). 
 
 A registered principal extends the base concept of an principal, by adding in additional fields needed for local registration, specifically password management information.
 
@@ -70,8 +70,8 @@ export interface RegisteredPrincipal extends Principal {
 
 **Code: A valid user model**
 ```typescript
-import { Model } from '@travetto/model';
 import type { RegisteredPrincipal } from '@travetto/auth-model';
+import { Model } from '@travetto/model';
 
 @Model()
 export class User implements RegisteredPrincipal {
@@ -88,12 +88,12 @@ export class User implements RegisteredPrincipal {
 ```
 
 ## Configuration
-Additionally, there exists a common practice of mapping various external security principals into a local contract. These external identities, as provided from countless authentication schemes, need to be homogenized for use.  This has been handled in other frameworks by using external configuration, and creating a mapping between the two set of fields.  Within this module, the mappings are defined as functions in which you can translate to the model from an identity or to an identity from a model.
+Additionally, there exists a common practice of mapping various external security principals into a local contract. These external identities, as provided from countless authentication schemes, need to be homogenized for use. This has been handled in other frameworks by using external configuration, and creating a mapping between the two set of fields. Within this module, the mappings are defined as functions in which you can translate to the model from an identity or to an identity from a model.
 
 **Code: Principal Source configuration**
 ```typescript
-import { InjectableFactory } from '@travetto/di';
 import { ModelAuthService } from '@travetto/auth-model';
+import { InjectableFactory } from '@travetto/di';
 import type { ModelCrudSupport } from '@travetto/model';
 
 import { User } from './model.ts';
@@ -104,7 +104,8 @@ class AuthConfig {
     return new ModelAuthService(
       service,
       User,
-      user => ({    // This converts User to a RegisteredPrincipal
+      user => ({
+        // This converts User to a RegisteredPrincipal
         source: 'model',
         provider: 'model',
         id: user.id!,
@@ -114,17 +115,18 @@ class AuthConfig {
         resetToken: user.resetToken,
         resetExpires: user.resetExpires,
         password: user.password,
-        details: user,
+        details: user
       }),
-      user => User.from(({   // This converts a RegisteredPrincipal to a User
-        id: user.id,
-        permissions: [...(user.permissions || [])],
-        hash: user.hash,
-        salt: user.salt,
-        resetToken: user.resetToken,
-        resetExpires: user.resetExpires,
-      })
-      )
+      user =>
+        User.from({
+          // This converts a RegisteredPrincipal to a User
+          id: user.id,
+          permissions: [...(user.permissions || [])],
+          hash: user.hash,
+          salt: user.salt,
+          resetToken: user.resetToken,
+          resetExpires: user.resetExpires
+        })
     );
   }
 }
@@ -132,15 +134,14 @@ class AuthConfig {
 
 **Code: Sample usage**
 ```typescript
-import { RuntimeError } from '@travetto/runtime';
-import { Injectable, Inject } from '@travetto/di';
 import type { ModelAuthService } from '@travetto/auth-model';
+import { Inject, Injectable } from '@travetto/di';
+import { RuntimeError } from '@travetto/runtime';
 
 import type { User } from './model.ts';
 
 @Injectable()
 class UserService {
-
   @Inject()
   private auth: ModelAuthService<User>;
 
@@ -181,6 +182,6 @@ export class AuthModelUtil {
    * @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 }>;
 }
 ```

package/__index__.ts

@@ -1,2 +1,2 @@
 export * from './src/model.ts';
-export * from './src/util.ts';
+export * from './src/util.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/auth-model",
-  "version": "8.0.0-alpha.22",
+  "version": "8.0.0-alpha.24",
   "type": "module",
   "description": "Authentication model support for the Travetto framework",
   "keywords": [
@@ -26,11 +26,11 @@
     "directory": "module/auth-model"
   },
   "dependencies": {
-    "@travetto/auth": "^8.0.0-alpha.19",
-    "@travetto/model": "^8.0.0-alpha.22"
+    "@travetto/auth": "^8.0.0-alpha.21",
+    "@travetto/model": "^8.0.0-alpha.24"
   },
   "peerDependencies": {
-    "@travetto/test": "^8.0.0-alpha.20"
+    "@travetto/test": "^8.0.0-alpha.22"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/model.ts

@@ -1,6 +1,6 @@
-import { Util, type Class, TimeUtil, castTo } from '@travetto/runtime';
+import { AuthenticationError, type Authenticator, type Authorizer, type Principal } from '@travetto/auth';
 import { type ModelCrudSupport, type ModelType, NotFoundError, type OptionalId } from '@travetto/model';
-import { type Principal, type Authenticator, type Authorizer, AuthenticationError } from '@travetto/auth';
+import { type Class, castTo, TimeUtil, Util } from '@travetto/runtime';
 
 import { AuthModelUtil } from './util.ts';
 
@@ -38,7 +38,6 @@ type FromPrincipal<T extends ModelType> = (item: Partial<RegisteredPrincipal>) =
  * A model-based auth service
  */
 export class ModelAuthService<T extends ModelType> implements Authenticator<T>, Authorizer {
-
   #modelService: ModelCrudSupport;
   #cls: Class<T>;
 
@@ -52,12 +51,7 @@ export class ModelAuthService<T extends ModelType> implements Authenticator<T>,
    * @param toPrincipal Convert a model to an principal
    * @param fromPrincipal Convert an identity to the model
    */
-  constructor(
-    modelService: ModelCrudSupport,
-    cls: Class<T>,
-    toPrincipal: ToPrincipal<T>,
-    fromPrincipal: FromPrincipal<T>,
-  ) {
+  constructor(modelService: ModelCrudSupport, cls: Class<T>, toPrincipal: ToPrincipal<T>, fromPrincipal: FromPrincipal<T>) {
     this.#modelService = modelService;
     this.#cls = cls;
     this.toPrincipal = toPrincipal;
@@ -181,4 +175,4 @@ export class ModelAuthService<T extends ModelType> implements Authenticator<T>,
     const { id, password } = this.toPrincipal(payload);
     return this.#authenticate(id, password!);
   }
-}
+}

package/src/util.ts

@@ -4,7 +4,6 @@ import { BinaryUtil, CodecUtil, RuntimeError, Util } from '@travetto/runtime';
  * Standard auth utilities
  */
 export class AuthModelUtil {
-
   /**
    * Generate a hash for a given value
    *
@@ -28,7 +27,7 @@ export class AuthModelUtil {
         name: 'PBKDF2',
         hash: { name: digest },
         salt: BinaryUtil.binaryArrayToBuffer(CodecUtil.fromUTF8String(salt)),
-        iterations,
+        iterations
       },
       hashKey,
       keylen * 8
@@ -44,7 +43,7 @@ export class AuthModelUtil {
    * @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 }> {
     if (!password) {
       throw new RuntimeError('Password is required', { category: 'data' });
     }
@@ -54,4 +53,4 @@ export class AuthModelUtil {
 
     return { salt, hash };
   }
-}
+}

package/support/test/model.ts

@@ -1,9 +1,10 @@
 import assert from 'node:assert';
 
-import { RuntimeError, castTo, type Class } from '@travetto/runtime';
-import { Suite, Test } from '@travetto/test';
 import { Inject, InjectableFactory } from '@travetto/di';
-import { type ModelCrudSupport, Model, Transient } from '@travetto/model';
+import { Model, type ModelCrudSupport, Transient } from '@travetto/model';
+import { type Class, castTo, RuntimeError } from '@travetto/runtime';
+import { Suite, Test } from '@travetto/test';
+
 import { InjectableSuite } from '@travetto/di/support/test/suite.ts';
 import { ModelSuite } from '@travetto/model/support/test/suite.ts';
 
@@ -41,7 +42,6 @@ class TestConfig {
 @ModelSuite()
 @InjectableSuite()
 export abstract class AuthModelServiceSuite<T> {
-
   serviceClass: Class<T>;
   configClass: Class;
 
@@ -88,4 +88,4 @@ export abstract class AuthModelServiceSuite<T> {
 
     await assert.doesNotReject(() => this.authService.authenticate(pre));
   }
-}
+}