enhanced user properties

elbwalker · Jun 5, 2024 · 64117ae · 64117ae
1 parent ab78abd
commit 64117ae
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 2 deletions.
diff --git a/packages/clients/walkerjs/src/__tests__/commands.test.ts b/packages/clients/walkerjs/src/__tests__/commands.test.ts
@@ -1,6 +1,7 @@
+import type { WebClient } from '..';
+import type { WalkerOS } from '@elbwalker/types';
 import { elb, Walkerjs } from '..';
 import { mockDataLayer } from '@elbwalker/jest/web.setup';
-import type { WebClient } from '..';
 
 describe('Commands', () => {
   let walkerjs: WebClient.Instance;
@@ -80,6 +81,28 @@ describe('Commands', () => {
         },
       }),
     );
+
+    const user: WalkerOS.User = {
+      userAgent: 'Mozilla...',
+      browser: 'Chrome',
+      browserVersion: '90',
+      deviceType: 'desktop',
+      language: 'de-DE',
+      country: 'DE',
+      region: 'HH',
+      city: 'Hamburg',
+      timezone: 'Berlin',
+      os: 'walkerOS',
+      osVersion: '1.0',
+      screenSize: '1337x420',
+      ip: 'xxx',
+      internal: true,
+      custom: 'value',
+    };
+    elb('walker user', user);
+    expect(walkerjs.user).toStrictEqual(
+      expect.objectContaining({ ...user, id: 'userId' }),
+    );
   });
 
   test('walker consent', () => {

diff --git a/packages/types/src/walkeros.ts b/packages/types/src/walkeros.ts
@@ -109,11 +109,27 @@ export type Commands =
   | 'walker'
   | string;
 
-export interface User {
+export interface User extends Properties {
+  // IDs
   id?: string;
   device?: string;
   session?: string;
   hash?: string;
+  // User related
+  userAgent?: string;
+  browser?: string;
+  browserVersion?: string;
+  deviceType?: string;
+  language?: string;
+  country?: string;
+  region?: string;
+  city?: string;
+  timezone?: string;
+  os?: string;
+  osVersion?: string;
+  screenSize?: string;
+  ip?: string;
+  internal?: boolean;
 }
 
 export interface Version {