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

package/README.md

@@ -13,11 +13,11 @@ 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 support 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 support 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 support 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 support 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 support 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 support 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 support for creating Web Applications") 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 support for creating Web Applications") module. 
 
-Within the framework the sessions are stored against any [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") implementation that provides [ModelExpirySupport](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10), as the data needs to be able to be expired appropriately.  The list of supported model providers are:
+Within the framework the sessions are stored against any [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") implementation that provides [ModelExpirySupport](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10), as the data needs to be able to be expired appropriately. The list of supported model providers are:
    *  [Redis Model Support](https://github.com/travetto/travetto/tree/main/module/model-redis#readme "Redis backing for the travetto model module.")
    *  [MongoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-mongo#readme "Mongo backing for the travetto model module.")
    *  [S3 Model Support](https://github.com/travetto/travetto/tree/main/module/model-s3#readme "S3 backing for the travetto model module.")
@@ -26,12 +26,11 @@ Within the framework the sessions are stored against any [Data Modeling Support]
    *  [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.
+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**
 ```typescript
 export class AuthSessionInterceptor implements WebInterceptor {
-
   category: WebInterceptorCategory = 'application';
   dependsOn = [AuthContextInterceptor];
 
@@ -61,7 +60,7 @@ export class AuthSessionInterceptor implements WebInterceptor {
 }
 ```
 
-The [SessionService](https://github.com/travetto/travetto/tree/main/module/auth-session/src/service.ts#L14) provides the basic integration with the [AuthContext](https://github.com/travetto/travetto/tree/main/module/auth/src/context.ts#L14) to authenticate and isolate session data.  The usage is fairly simple, but the import pattern to follow is:
+The [SessionService](https://github.com/travetto/travetto/tree/main/module/auth-session/src/service.ts#L14) provides the basic integration with the [AuthContext](https://github.com/travetto/travetto/tree/main/module/auth/src/context.ts#L14) to authenticate and isolate session data. The usage is fairly simple, but the import pattern to follow is:
    *  load
    *  read/modify
    *  persist

package/__index__.ts

@@ -1,4 +1,4 @@
-export * from './src/service.ts';
 export * from './src/context.ts';
 export * from './src/model.ts';
-export * from './src/session.ts';
+export * from './src/service.ts';
+export * from './src/session.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/auth-session",
-  "version": "8.0.0-alpha.22",
+  "version": "8.0.0-alpha.24",
   "type": "module",
   "description": "Session provider for the travetto auth module.",
   "keywords": [
@@ -26,12 +26,12 @@
     "directory": "module/auth-session"
   },
   "dependencies": {
-    "@travetto/auth": "^8.0.0-alpha.19",
-    "@travetto/config": "^8.0.0-alpha.21",
-    "@travetto/model": "^8.0.0-alpha.22"
+    "@travetto/auth": "^8.0.0-alpha.21",
+    "@travetto/config": "^8.0.0-alpha.23",
+    "@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/context.ts

@@ -1,6 +1,6 @@
-import { Injectable, Inject } from '@travetto/di';
-import { type AsyncContext, AsyncContextValue } from '@travetto/context';
 import { type AuthContext, AuthenticationError } from '@travetto/auth';
+import { type AsyncContext, AsyncContextValue } from '@travetto/context';
+import { Inject, Injectable } from '@travetto/di';
 
 import { Session } from './session.ts';
 
@@ -9,7 +9,6 @@ import { Session } from './session.ts';
  */
 @Injectable()
 export class SessionContext {
-
   @Inject()
   context: AsyncContext;
 
@@ -28,7 +27,7 @@ export class SessionContext {
       expiresAt: principal.expiresAt,
       issuedAt: principal.issuedAt,
       action: 'create',
-      data: {},
+      data: {}
     });
   }
 
@@ -40,7 +39,7 @@ export class SessionContext {
   get(createIfMissing?: boolean): Session | undefined {
     let value = this.#value.get();
     if (!value && createIfMissing) {
-      this.set(value = this.#create());
+      this.set((value = this.#create()));
     }
     return value;
   }
@@ -59,4 +58,4 @@ export class SessionContext {
     this.get()?.destroy();
     this.set(undefined);
   }
-}
+}

package/src/model.ts

@@ -1,4 +1,4 @@
-import { Model, ExpiresAt } from '@travetto/model';
+import { ExpiresAt, Model } from '@travetto/model';
 import { Text } from '@travetto/schema';
 
 /**

package/src/service.ts

@@ -1,18 +1,17 @@
-import { Injectable, Inject } from '@travetto/di';
-import { JSONUtil } from '@travetto/runtime';
-import { type ModelExpirySupport, NotFoundError } from '@travetto/model';
 import type { AuthContext, AuthService } from '@travetto/auth';
+import { Inject, Injectable } from '@travetto/di';
+import { type ModelExpirySupport, NotFoundError } from '@travetto/model';
+import { JSONUtil } from '@travetto/runtime';
 
-import { Session } from './session.ts';
-import { SessionEntry, SessionModelSymbol } from './model.ts';
 import type { SessionContext } from './context.ts';
+import { SessionEntry, SessionModelSymbol } from './model.ts';
+import { Session } from './session.ts';
 
 /**
  * Service for supporting the session and managing the session state
  */
 @Injectable()
 export class SessionService {
-
   @Inject()
   context: SessionContext;
 
@@ -43,7 +42,7 @@ export class SessionService {
 
       // Validate session
       if (session.isExpired()) {
-        await this.#modelService.delete(SessionEntry, session.id).catch(() => { });
+        await this.#modelService.delete(SessionEntry, session.id).catch(() => {});
         return new Session({ action: 'destroy' });
       } else {
         return session;
@@ -78,14 +77,18 @@ export class SessionService {
 
       // If expiration time has changed, send new session information
       if (session.action === 'create' || session.isChanged()) {
-        await this.#modelService.upsert(SessionEntry, SessionEntry.from({
-          ...session,
-          data: JSONUtil.toBase64(session.data)
-        }));
+        await this.#modelService.upsert(
+          SessionEntry,
+          SessionEntry.from({
+            ...session,
+            data: JSONUtil.toBase64(session.data)
+          })
+        );
       }
       // If destroying
-    } else if (session.id) { // If destroy and id
-      await this.#modelService.delete(SessionEntry, session.id).catch(() => { });
+    } else if (session.id) {
+      // If destroy and id
+      await this.#modelService.delete(SessionEntry, session.id).catch(() => {});
     }
   }
 
@@ -101,4 +104,4 @@ export class SessionService {
     }
     return this.context.get();
   }
-}
+}

package/src/session.ts

@@ -1,10 +1,9 @@
 import { type AnyMap, castKey, castTo, JSONUtil } from '@travetto/runtime';
 
-
 /**
  * @concrete
  */
-export interface SessionData extends AnyMap { }
+export interface SessionData extends AnyMap {}
 
 /**
  * Full session object, with metadata
@@ -124,4 +123,4 @@ export class Session<T extends SessionData = SessionData> {
       data: this.data
     };
   }
-}
+}

package/support/test/server.ts

@@ -1,11 +1,11 @@
 import assert from 'node:assert';
 
-import { Suite, Test } from '@travetto/test';
-import { Inject } from '@travetto/di';
-import type { SessionContext, SessionService } from '@travetto/auth-session';
 import { type AuthContext, AuthenticationError } from '@travetto/auth';
+import type { SessionContext, SessionService } from '@travetto/auth-session';
 import { type AsyncContext, WithAsyncContext } from '@travetto/context';
-import { Util, type Class } from '@travetto/runtime';
+import { Inject } from '@travetto/di';
+import { type Class, Util } 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';
@@ -14,7 +14,6 @@ import { ModelSuite } from '@travetto/model/support/test/suite.ts';
 @ModelSuite()
 @InjectableSuite()
 export abstract class AuthSessionServerSuite<T> {
-
   timeScale = 1;
   serviceClass: Class<T>;
   configClass: Class;
@@ -41,7 +40,7 @@ export abstract class AuthSessionServerSuite<T> {
     };
 
     assert(this.sessionContext.get() === undefined);
-    assert(await this.session.load() === undefined);
+    assert((await this.session.load()) === undefined);
 
     const session = this.sessionContext.get(true);
     assert(session.id === this.auth.principal.sessionId);
@@ -50,7 +49,7 @@ export abstract class AuthSessionServerSuite<T> {
 
     this.sessionContext.set(undefined); // Disconnect
 
-    assert(await this.session.load() !== undefined);
+    assert((await this.session.load()) !== undefined);
     const session2 = this.sessionContext.get(true);
     assert(session2.data?.name === 'bob');
 
@@ -62,7 +61,7 @@ export abstract class AuthSessionServerSuite<T> {
 
     this.sessionContext.set(undefined); // Disconnect
 
-    assert(await this.session.load() === undefined);
+    assert((await this.session.load()) === undefined);
     const session3 = this.sessionContext.get(true);
     assert.deepStrictEqual(session3.data, {});
   }
@@ -72,4 +71,4 @@ export abstract class AuthSessionServerSuite<T> {
   async testUnauthenticatedSession() {
     assert.throws(() => this.sessionContext.get(true), AuthenticationError);
   }
-}
+}