Merge pull request #2902 from mainmatter/feat-add-generic-data-argument

feat(ember-simple-auth): add generic type argument to session

Author: BobrImperator

README.md

@@ -151,6 +151,21 @@ import AdaptiveStore from 'ember-simple-auth/session-stores/adaptive';
 export default class SessionStore extends AdaptiveStore {}
 ```
 
+#### Optional Generic `Data` argument.
+
+```ts
+import Service from 'ember-simple-auth/services/session';
+
+type Data = {
+  authenticated: {
+    // Any data your authenticators return
+    id: string;
+  }
+}
+
+export default class SessionService<Data> extends Service {}
+```
+
 then __the session service can be injected wherever
 needed in the application__. In order to display login/logout buttons depending
 on the current session state, inject the service into the respective controller

packages/ember-simple-auth/src/services/session.ts

@@ -26,9 +26,9 @@ function assertSetupHasBeenCalled(isSetupCalled: boolean) {
 
 type RouteOrCallback = string | (() => void);
 
-type InternalSessionMock = {
+type InternalSessionMock<Data> = {
   isAuthenticated: boolean;
-  content: { authenticated: Record<string, string> };
+  content: Data;
   store: unknown;
   attemptedTransition: null;
   on: (event: 'authenticationSucceeded' | 'invalidationSucceeded', cb: () => void) => void;
@@ -40,6 +40,13 @@ type InternalSessionMock = {
   set(key: string, value: any): void;
 };
 
+export type DefaultDataShape = {
+  authenticated: {
+    authenticator: string;
+    [key: string]: string;
+  };
+};
+
 /**
   __The session service provides access to the current session as well as
   methods to authenticate it, invalidate it, etc.__ It is the main interface for
@@ -59,13 +66,13 @@ type InternalSessionMock = {
   @extends Service
   @public
 */
-export default class SessionService extends Service {
-  session: InternalSessionMock;
+export default class SessionService<Data = DefaultDataShape> extends Service {
+  session: InternalSessionMock<Data>;
 
   constructor(owner: any) {
     super(owner);
 
-    this.session = owner.lookup('session:main') as InternalSessionMock;
+    this.session = owner.lookup('session:main');
   }
 
   /**

packages/test-app/app/controllers/index.ts

@@ -4,4 +4,10 @@ import type SessionService from 'test-app/services/session';
 
 export default class ApplicationIndexController extends Controller {
   @service declare session: SessionService;
+
+  constructor(owner: any) {
+    super(owner);
+
+    console.log(this.session.data.authenticated.id);
+  }
 }

packages/test-app/app/services/session.ts

@@ -1,7 +1,13 @@
 import { inject as service } from '@ember/service';
 import Session from 'ember-simple-auth/services/session';
 
-export default class SessionService extends Session {
+type Data = {
+  authenticated: {
+    id: string;
+  };
+};
+
+export default class SessionService extends Session<Data> {
   @service sessionAccount: any;
 
   handleAuthentication(routeAfterInvalidation: string) {