on session

packages/clients/walkerjs/src/__tests__/commands.test.ts → packages/clients/walkerjs/src/__tests__/on.test.ts

@@ -2,7 +2,7 @@ import { elb, Walkerjs } from '..';
 import { mockDataLayer } from '@elbwalker/jest/web.setup';
 import type { WebClient } from '..';
 
-describe('Commands on consent', () => {
+describe('On Consent', () => {
   let walkerjs: WebClient.Instance;
 
   beforeEach(() => {
@@ -133,7 +133,7 @@ describe('Commands on consent', () => {
   });
 });
 
-describe('Commands on run', () => {
+describe('On Run', () => {
   let walkerjs: WebClient.Instance;
 
   beforeEach(() => {
@@ -270,3 +270,35 @@ describe('Commands on run', () => {
     );
   });
 });
+
+describe('On Session', () => {
+  let walkerjs: WebClient.Instance;
+  const mockFn = jest.fn();
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    walkerjs = Walkerjs({ run: true });
+  });
+
+  test('register', () => {
+    walkerjs = Walkerjs({ run: true, on: { session: [mockFn] } });
+    const mockFnOn = jest.fn();
+    elb('walker on', 'session', mockFnOn);
+
+    expect(walkerjs.on.session![0]).toBe(mockFn);
+    expect(walkerjs.on.session![1]).toBe(mockFnOn);
+  });
+
+  test('session disabled', () => {
+    jest.clearAllMocks();
+    walkerjs = Walkerjs({ run: true, session: false });
+
+    elb('walker on', 'session', mockFn);
+    expect(mockFn).toHaveBeenCalledTimes(0);
+  });
+
+  test('basics', () => {
+    elb('walker on', 'session', mockFn);
+    expect(mockFn).toHaveBeenCalledTimes(1);
+  });
+});

packages/clients/walkerjs/src/index.ts

@@ -599,11 +599,11 @@ export function Walkerjs(
         data: config.sessionStatic, // Static default session data
         instance,
       });
+
       if (session) {
         instance.session = session;
+        onApply(instance, 'session');
       }
-
-      // @TODO on-event for session
     }
 
     tryCatch(load)(instance);

packages/clients/walkerjs/src/lib/on.ts

@@ -19,6 +19,9 @@ export function onApply(
     case Const.Commands.Run:
       onRun(instance, onConfig as Array<On.RunConfig>);
       break;
+    case Const.Commands.Session:
+      onSession(instance, onConfig as Array<On.SessionConfig>);
+      break;
     default:
       break;
   }
@@ -52,3 +55,15 @@ function onRun(
       tryCatch(func)(instance);
     });
 }
+
+function onSession(
+  instance: WebClient.Instance,
+  onConfig: Array<On.SessionConfig>,
+): void {
+  const { session } = instance;
+
+  if (session)
+    onConfig.forEach((func) => {
+      tryCatch(func)(instance, session);
+    });
+}

packages/types/src/on.ts

@@ -1,19 +1,21 @@
-import { WalkerOS } from './';
+import type { WalkerOS } from './';
+import type { SessionData } from '@elbwalker/utils';
 
 // Instance state for the on actions
 export type Config = {
   consent?: Array<ConsentConfig>;
   run?: Array<RunConfig>;
+  session?: Array<SessionConfig>;
 };
 
 // On types
 export type Types = keyof Config;
 
 // Function definitions for the on actions
-export type Functions = ConsentFn | RunFn;
+export type Functions = ConsentFn | RunFn | SessionFn;
 
 // Parameters for the onAction function calls
-export type Options = ConsentConfig | RunConfig;
+export type Options = ConsentConfig | RunConfig | SessionConfig;
 
 // Consent
 export interface ConsentConfig {
@@ -27,3 +29,10 @@ export type ConsentFn = (
 // Run
 export type RunConfig = RunFn;
 export type RunFn = (instance: WalkerOS.Instance) => void;
+
+// Session
+export type SessionConfig = SessionFn;
+export type SessionFn = (
+  instance: WalkerOS.Instance,
+  session: SessionData,
+) => void;

packages/utils/src/core/constants.ts

@@ -16,6 +16,7 @@ export type CommandTypes =
   | 'On'
   | 'Prefix'
   | 'Run'
+  | 'Session'
   | 'User'
   | 'Walker';
 
@@ -35,6 +36,7 @@ export const Commands: Record<CommandTypes, WalkerOS.Commands> = {
   On: 'on',
   Prefix: 'data-elb',
   Run: 'run',
+  Session: 'session',
   User: 'user',
   Walker: 'walker',
 } as const;