@travetto/auth-web-session 6.0.0-rc.4

package/README.md

@@ -0,0 +1,85 @@
+<!-- This file was generated by @travetto/doc and should not be modified directly -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/auth-web-session/DOC.tsx and execute "npx trv doc" to rebuild -->
+# Web Auth Session
+
+## Web authentication session integration support for the Travetto framework
+
+**Install: @travetto/auth-web-session**
+```bash
+npm install @travetto/auth-web-session
+
+# or
+
+yarn add @travetto/auth-web-session
+```
+
+One of [Web Auth](https://github.com/travetto/travetto/tree/main/module/auth-web#readme "Web authentication integration support for the Travetto framework")'s main responsibility is being able to send, validate and receive authentication/authorization information from the client. 
+
+This module's main responsibilities is to expose [Auth Session](https://github.com/travetto/travetto/tree/main/module/auth-session#readme "Session provider for the travetto auth module.")'s data within the scope of an authenticated request flow.
+
+**Code: Anatomy of the Session Interceptor**
+```typescript
+export class AuthSessionInterceptor implements WebInterceptor {
+
+  category: WebInterceptorCategory = 'application';
+  dependsOn = [AuthContextInterceptor];
+
+  @Inject()
+  service: SessionService;
+
+  @Inject()
+  context: SessionContext;
+
+  @Inject()
+  webAsyncContext: WebAsyncContext;
+
+  postConstruct(): void {
+    this.webAsyncContext.registerSource(toConcrete<Session>(), () => this.context.get(true));
+    this.webAsyncContext.registerSource(toConcrete<SessionData>(), () => this.context.get(true).data);
+  }
+
+  async filter({ next }: WebChainedContext): Promise<WebResponse> {
+    try {
+      await this.service.load();
+      return await next();
+    } finally {
+      await this.service.persist();
+    }
+  }
+}
+```
+
+Once operating within the [Session](https://github.com/travetto/travetto/tree/main/module/auth-session/src/session.ts#L6) boundaries, the session state can be injected via [@ContextParam](https://github.com/travetto/travetto/tree/main/module/web/src/decorator/param.ts#L61)s, injected as [SessionContext](https://github.com/travetto/travetto/tree/main/module/auth-session/src/context.ts#L11),  or accessed via the [SessionService](https://github.com/travetto/travetto/tree/main/module/auth-session/src/service.ts#L14).
+
+**Code: Sample Usage**
+```typescript
+@Authenticated()
+@Controller('/session')
+export class SessionEndpoints {
+
+  @Inject()
+  session: SessionContext;
+
+  @ContextParam()
+  data: SessionData;
+
+  @Put('/info')
+  async storeInfo() {
+    if (this.data) {
+      this.data.age = 20;
+      this.data.name = 'Roger'; // Setting data
+    }
+  }
+
+  @Get('/logout')
+  async logout() {
+    await this.session.destroy();
+  }
+
+  @Get('/info/age')
+  async getInfo() {
+    const { data } = this.session.get(true);
+    return data?.age;
+  }
+}
+```

package/__index__.ts

@@ -0,0 +1 @@
+export * from './src/interceptor.ts';

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@travetto/auth-web-session",
+  "version": "6.0.0-rc.4",
+  "description": "Web authentication session integration support for the Travetto framework",
+  "keywords": [
+    "authentication",
+    "session",
+    "web",
+    "travetto",
+    "typescript"
+  ],
+  "homepage": "https://travetto.io",
+  "license": "MIT",
+  "author": {
+    "email": "travetto.framework@gmail.com",
+    "name": "Travetto Framework"
+  },
+  "files": [
+    "__index__.ts",
+    "src"
+  ],
+  "main": "__index__.ts",
+  "repository": {
+    "url": "git+https://github.com/travetto/travetto.git",
+    "directory": "module/auth-web-session"
+  },
+  "dependencies": {
+    "@travetto/auth": "^6.0.0-rc.2",
+    "@travetto/auth-session": "^6.0.0-rc.2",
+    "@travetto/auth-web": "^6.0.0-rc.4",
+    "@travetto/di": "^6.0.0-rc.2",
+    "@travetto/web": "^6.0.0-rc.2"
+  },
+  "travetto": {
+    "displayName": "Web Auth Session"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/interceptor.ts

@@ -0,0 +1,38 @@
+import { toConcrete } from '@travetto/runtime';
+import { Injectable, Inject } from '@travetto/di';
+import { WebInterceptor, WebAsyncContext, WebInterceptorCategory, WebChainedContext, WebResponse } from '@travetto/web';
+import { Session, SessionContext, SessionData, SessionService } from '@travetto/auth-session';
+import { AuthContextInterceptor } from '@travetto/auth-web';
+
+/**
+ * Loads session, and provides ability to create session as needed, persists when complete.
+ */
+@Injectable()
+export class AuthSessionInterceptor implements WebInterceptor {
+
+  category: WebInterceptorCategory = 'application';
+  dependsOn = [AuthContextInterceptor];
+
+  @Inject()
+  service: SessionService;
+
+  @Inject()
+  context: SessionContext;
+
+  @Inject()
+  webAsyncContext: WebAsyncContext;
+
+  postConstruct(): void {
+    this.webAsyncContext.registerSource(toConcrete<Session>(), () => this.context.get(true));
+    this.webAsyncContext.registerSource(toConcrete<SessionData>(), () => this.context.get(true).data);
+  }
+
+  async filter({ next }: WebChainedContext): Promise<WebResponse> {
+    try {
+      await this.service.load();
+      return await next();
+    } finally {
+      await this.service.persist();
+    }
+  }
+}