@travetto/auth-session 6.0.0-rc.2 → 6.0.0-rc.3

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/auth-session
 yarn add @travetto/auth-session
 ```
 
-This is a module that adds session support to the [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication scaffolding for the Travetto framework") framework, via [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") storage.  The concept here, is that the [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication scaffolding for the Travetto framework") module provides the solid foundation for ensuring authentication to the system, and transitively to the session data. The [Principal](https://github.com/travetto/travetto/tree/main/module/auth/src/types/principal.ts#L7) provides a session identifier, which refers to a unique authentication session.  Each login will produce a novel session id.  This id provides the contract between [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication scaffolding for the Travetto framework") and[Auth Session](https://github.com/travetto/travetto/tree/main/module/auth-session#readme "Session provider for the travetto auth module.").  
+This is a module that adds session support to the [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication scaffolding for the Travetto framework") framework, via [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") storage.  The concept here, is that the [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication scaffolding for the Travetto framework") module provides the solid foundation for ensuring authentication to the system, and transitively to the session data. The [Principal](https://github.com/travetto/travetto/tree/main/module/auth/src/types/principal.ts#L8) provides a session identifier, which refers to a unique authentication session.  Each login will produce a novel session id.  This id provides the contract between [Authentication](https://github.com/travetto/travetto/tree/main/module/auth#readme "Authentication scaffolding for the Travetto framework") and[Auth Session](https://github.com/travetto/travetto/tree/main/module/auth-session#readme "Session provider for the travetto auth module.").  
 
 This session identifier, is then used when retrieving data from [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") storage. This storage mechanism is not tied to a request/response model, but the [Web Auth Session](https://github.com/travetto/travetto/tree/main/module/auth-web-session#readme "Web authentication session integration support for the Travetto framework") does provide a natural integration with the [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative api for Web Applications with support for the dependency injection.") module.   
 
@@ -25,6 +25,7 @@ Within the framework the sessions are stored against any [Data Modeling Support]
    *  [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.")
    *  [File Model Support](https://github.com/travetto/travetto/tree/main/module/model-file#readme "File system backing for the travetto model module.")
    *  [Memory Model Support](https://github.com/travetto/travetto/tree/main/module/model-memory#readme "Memory backing for the travetto model module.")
+
 While the expiry is not necessarily a hard requirement, the implementation without it can be quite messy.  To that end, the ability to add [ModelExpirySupport](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10) to the model provider would be the natural extension point if more expiry support is needed.
 
 **Code: Sample usage of Session Service**
@@ -63,4 +64,5 @@ The [SessionService](https://github.com/travetto/travetto/tree/main/module/auth-
    *  load
    *  read/modify
    *  persist
+
 And note, persist is intelligent enough to only update the data store if the expiration date has changed or if the data in the session has been modified.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/auth-session",
-  "version": "6.0.0-rc.2",
+  "version": "6.0.0-rc.3",
   "description": "Session provider for the travetto auth module.",
   "keywords": [
     "auth",
@@ -25,12 +25,12 @@
     "directory": "module/auth-session"
   },
   "dependencies": {
-    "@travetto/auth": "^6.0.0-rc.2",
+    "@travetto/auth": "^6.0.0-rc.3",
     "@travetto/config": "^6.0.0-rc.2",
     "@travetto/model": "^6.0.0-rc.2"
   },
   "peerDependencies": {
-    "@travetto/test": "^6.0.0-rc.2"
+    "@travetto/test": "^6.0.0-rc.3"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/session.ts

@@ -2,11 +2,13 @@ import { AnyMap, castKey, castTo } from '@travetto/runtime';
 
 /**
  * @concrete
+ * @web_contextual
  */
 export interface SessionData extends AnyMap { }
 
 /**
  * Full session object, with metadata
+ * @web_contextual
  */
 export class Session<T extends SessionData = SessionData> {
   /**