@travetto/auth-model 3.0.2 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +3 -6
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  <!-- This file was generated by @travetto/doc and should not be modified directly -->
2
- <!-- Please modify https://github.com/travetto/travetto/tree/main/module/auth-model/DOC.ts and execute "npx trv doc" to rebuild -->
2
+ <!-- Please modify https://github.com/travetto/travetto/tree/main/module/auth-model/DOC.tsx and execute "npx trv doc" to rebuild -->
3
3
  # Authentication Model
4
+
4
5
  ## Authentication model support for the Travetto framework
5
6
 
6
7
  **Install: @travetto/auth-model**
@@ -24,9 +25,7 @@ npm install @travetto/model-{provider}
24
25
 
25
26
  yarn add @travetto/model-{provider}
26
27
  ```
27
-
28
28
  Currently, the following are packages that provide [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11):
29
-
30
29
  * [DynamoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-dynamodb#readme "DynamoDB backing for the travetto model module.") - @travetto/model-dynamodb
31
30
  * [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
32
31
  * [Firestore Model Support](https://github.com/travetto/travetto/tree/main/module/model-firestore#readme "Firestore backing for the travetto model module.") - @travetto/model-firestore
@@ -36,8 +35,7 @@ Currently, the following are packages that provide [CRUD](https://github.com/tra
36
35
  * [MySQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-mysql#readme "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-mysql
37
36
  * [PostgreSQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-postgres#readme "PostgreSQL backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-postgres
38
37
  * [SQLite Model Service](https://github.com/travetto/travetto/tree/main/module/model-sqlite#readme "SQLite backing for the travetto model module, with real-time modeling support for SQL schemas.") - @travetto/model-sqlite
39
-
40
- 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 [Registered Principal](https://github.com/travetto/travetto/tree/main/module/auth-model/src/model.ts#L9)
38
+ 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 [Registered Principal](https://github.com/travetto/travetto/tree/main/module/auth-model/src/model.ts#L9).
41
39
 
42
40
  A registered principal extends the base concept of an principal, by adding in additional fields needed for local registration, specifically password management information.
43
41
 
@@ -87,7 +85,6 @@ export class User implements RegisteredPrincipal {
87
85
  ```
88
86
 
89
87
  ## Configuration
90
-
91
88
  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.
92
89
 
93
90
  **Code: Principal Source configuration**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@travetto/auth-model",
3
- "version": "3.0.2",
3
+ "version": "3.0.3",
4
4
  "description": "Authentication model support for the Travetto framework",
5
5
  "keywords": [
6
6
  "authentication",
@@ -25,11 +25,11 @@
25
25
  "directory": "module/auth-model"
26
26
  },
27
27
  "dependencies": {
28
- "@travetto/auth": "^3.0.2",
29
- "@travetto/model": "^3.0.2"
28
+ "@travetto/auth": "^3.0.3",
29
+ "@travetto/model": "^3.0.3"
30
30
  },
31
31
  "peerDependencies": {
32
- "@travetto/test": "^3.0.2"
32
+ "@travetto/test": "^3.0.3"
33
33
  },
34
34
  "peerDependenciesMeta": {
35
35
  "@travetto/test": {