Add role to directory user (#1046)

## Description Introduce roles to directory sync users for a beta release. ## Documentation Does this require changes to the WorkOS Docs? E.g. the [API Reference](https://workos.com/docs/reference) or code snippets need updates. ``` [ ] Yes ``` If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.
workos · May 21, 2024 · 8b2f642 · 8b2f642
1 parent 84038cf
commit 8b2f642
Show file tree

Hide file tree

Showing 10 changed files with 176 additions and 6 deletions.
diff --git a/src/common/interfaces/event.interface.ts b/src/common/interfaces/event.interface.ts
@@ -28,7 +28,7 @@ import {
 import {
   RoleEvent,
   RoleEventResponse,
-} from '../../user-management/interfaces/role.interface';
+} from '../../roles/interfaces/role.interface';
 
 export interface EventBase {
   id: string;

diff --git a/src/directory-sync/directory-sync.spec.ts b/src/directory-sync/directory-sync.spec.ts
@@ -126,6 +126,62 @@ describe('DirectorySync', () => {
     updated_at: '2021-12-13 12:15:45.531847',
   };
 
+  const userWithRole: DirectoryUserWithGroups = {
+    object: 'directory_user',
+    id: 'directory_user_456',
+    customAttributes: {
+      custom: true,
+    },
+    directoryId: 'dir_123',
+    organizationId: 'org_123',
+    emails: [
+      {
+        primary: true,
+        type: 'type',
+        value: '[email protected]',
+      },
+    ],
+    firstName: 'Jon',
+    groups: [group],
+    idpId: 'idp_foo',
+    lastName: 'Snow',
+    jobTitle: 'Knight of the Watch',
+    rawAttributes: {},
+    state: 'active',
+    username: 'jonsnow',
+    role: { slug: 'super_admin' },
+    createdAt: '2021-10-27 15:21:50.640959',
+    updatedAt: '2021-12-13 12:15:45.531847',
+  };
+
+  const userWithRoleResponse: DirectoryUserWithGroupsResponse = {
+    object: 'directory_user',
+    id: 'directory_user_456',
+    custom_attributes: {
+      custom: true,
+    },
+    directory_id: 'dir_123',
+    organization_id: 'org_123',
+    emails: [
+      {
+        primary: true,
+        type: 'type',
+        value: '[email protected]',
+      },
+    ],
+    first_name: 'Jon',
+    groups: [groupResponse],
+    idp_id: 'idp_foo',
+    last_name: 'Snow',
+    job_title: 'Knight of the Watch',
+    raw_attributes: {},
+    state: 'active',
+    username: 'jonsnow',
+    role: { slug: 'super_admin' },
+    created_at: '2021-10-27 15:21:50.640959',
+    updated_at: '2021-12-13 12:15:45.531847',
+  };
+
   describe('listDirectories', () => {
     describe('with options', () => {
       it('requests Directories with query parameters', async () => {
@@ -404,5 +460,17 @@ describe('DirectorySync', () => {
 
       expect(subject).toEqual(userWithGroup);
     });
+
+    describe('with a Role', () => {
+      it(`requests a Directory User`, async () => {
+        fetchOnce(userWithRoleResponse);
+
+        const subject = await workos.directorySync.getUser(
+          'directory_user_456',
+        );
+
+        expect(subject).toEqual(userWithRole);
+      });
+    });
   });
 });
diff --git a/src/directory-sync/interfaces/directory-user.interface.ts b/src/directory-sync/interfaces/directory-user.interface.ts
@@ -1,3 +1,4 @@
+import { RoleResponse } from '../../roles/interfaces/';
 import {
   DirectoryGroup,
   DirectoryGroupResponse,
@@ -26,6 +27,7 @@ export interface DirectoryUser<
   lastName: string | null;
   jobTitle: string | null;
   state: 'active' | 'inactive';
+  role?: RoleResponse;
   createdAt: string;
   updatedAt: string;
 }
@@ -51,6 +53,7 @@ export interface DirectoryUserResponse<
   last_name: string | null;
   job_title: string | null;
   state: 'active' | 'inactive';
+  role?: RoleResponse;
   created_at: string;
   updated_at: string;
 }

diff --git a/src/directory-sync/serializers/directory-user.serializer.ts b/src/directory-sync/serializers/directory-user.serializer.ts
@@ -27,6 +27,7 @@ export const deserializeDirectoryUser = <
   lastName: directoryUser.last_name,
   jobTitle: directoryUser.job_title,
   state: directoryUser.state,
+  role: directoryUser.role,
   createdAt: directoryUser.created_at,
   updatedAt: directoryUser.updated_at,
 });
@@ -56,6 +57,7 @@ export const deserializeUpdatedEventDirectoryUser = (
   lastName: directoryUser.last_name,
   jobTitle: directoryUser.job_title,
   state: directoryUser.state,
+  role: directoryUser.role,
   createdAt: directoryUser.created_at,
   updatedAt: directoryUser.updated_at,
   previousAttributes: directoryUser.previous_attributes,

diff --git a/src/events/events.spec.ts b/src/events/events.spec.ts
@@ -1,6 +1,12 @@
 import fetch from 'jest-fetch-mock';
 import { fetchOnce, fetchSearchParams } from '../common/utils/test-utils';
-import { Event, EventResponse, ListResponse } from '../common/interfaces';
+import {
+  DsyncUserUpdatedEvent,
+  DsyncUserUpdatedEventResponse,
+  Event,
+  EventResponse,
+  ListResponse,
+} from '../common/interfaces';
 import { WorkOS } from '../workos';
 import { ConnectionType } from '../sso/interfaces';
 
@@ -108,5 +114,97 @@ describe('Event', () => {
         listMetadata: {},
       });
     });
+
+    describe('directory user updated events', () => {
+      describe('with a role', () => {
+        const directoryUserUpdated: DsyncUserUpdatedEvent = {
+          id: 'event_01234ABCD',
+          createdAt: '2020-05-06 04:21:48.649164',
+          event: 'dsync.user.updated',
+          data: {
+            object: 'directory_user',
+            id: 'directory_user_456',
+            customAttributes: {
+              custom: true,
+            },
+            directoryId: 'dir_123',
+            organizationId: 'org_123',
+            emails: [
+              {
+                primary: true,
+                type: 'type',
+                value: '[email protected]',
+              },
+            ],
+            firstName: 'Jon',
+            idpId: 'idp_foo',
+            lastName: 'Snow',
+            jobTitle: 'Knight of the Watch',
+            rawAttributes: {},
+            state: 'active',
+            username: 'jonsnow',
+            role: { slug: 'super_admin' },
+            previousAttributes: {
+              role: { slug: 'member' },
+            },
+            createdAt: '2021-10-27 15:21:50.640959',
+            updatedAt: '2021-12-13 12:15:45.531847',
+          },
+        };
+
+        const directoryUserUpdatedResponse: DsyncUserUpdatedEventResponse = {
+          id: 'event_01234ABCD',
+          created_at: '2020-05-06 04:21:48.649164',
+          event: 'dsync.user.updated',
+          data: {
+            object: 'directory_user',
+            id: 'directory_user_456',
+            custom_attributes: {
+              custom: true,
+            },
+            directory_id: 'dir_123',
+            organization_id: 'org_123',
+            emails: [
+              {
+                primary: true,
+                type: 'type',
+                value: '[email protected]',
+              },
+            ],
+            first_name: 'Jon',
+            idp_id: 'idp_foo',
+            last_name: 'Snow',
+            job_title: 'Knight of the Watch',
+            raw_attributes: {},
+            state: 'active',
+            username: 'jonsnow',
+            role: { slug: 'super_admin' },
+            previous_attributes: {
+              role: { slug: 'member' },
+            },
+            created_at: '2021-10-27 15:21:50.640959',
+            updated_at: '2021-12-13 12:15:45.531847',
+          },
+        };
+        const directoryUserEventsListResponse: ListResponse<EventResponse> = {
+          object: 'list',
+          data: [directoryUserUpdatedResponse],
+          list_metadata: {},
+        };
+        it(`returns the role`, async () => {
+          fetchOnce(directoryUserEventsListResponse);
+
+          const list = await workos.events.listEvents({
+            events: ['dsync.user.updated'],
+          });
+
+          expect(list).toEqual({
+            object: 'list',
+            data: [directoryUserUpdated],
+            listMetadata: {},
+          });
+        });
+      });
+    });
   });
 });
diff --git a/src/roles/interfaces/index.ts b/src/roles/interfaces/index.ts
@@ -0,0 +1 @@
+export * from './role.interface';
diff --git a/...r-management/interfaces/role.interface.ts → src/roles/interfaces/role.interface.ts b/...r-management/interfaces/role.interface.ts → src/roles/interfaces/role.interface.ts
diff --git a/src/user-management/interfaces/index.ts b/src/user-management/interfaces/index.ts
@@ -24,7 +24,6 @@ export * from './magic-auth.interface';
 export * from './organization-membership.interface';
 export * from './reset-password-options.interface';
 export * from './revoke-session-options.interface';
-export * from './role.interface';
 export * from './send-invitation-options.interface';
 export * from './send-magic-auth-code-options.interface';
 export * from './send-password-reset-email-options.interface';
@@ -35,4 +34,3 @@ export * from './update-user-options.interface';
 export * from './update-user-password-options.interface';
 export * from './user.interface';
 export * from './verify-email-options.interface';
-export * from './role.interface';
diff --git a/src/user-management/interfaces/organization-membership.interface.ts b/src/user-management/interfaces/organization-membership.interface.ts
@@ -1,4 +1,4 @@
-import { RoleResponse } from './role.interface';
+import { RoleResponse } from '../../roles/interfaces/';
 
 export type OrganizationMembershipStatus = 'active' | 'inactive' | 'pending';
 

diff --git a/src/user-management/serializers/role.serializer.ts b/src/user-management/serializers/role.serializer.ts
@@ -1,4 +1,4 @@
-import { RoleEvent, RoleEventResponse } from '../interfaces';
+import { RoleEvent, RoleEventResponse } from '../../roles/interfaces';
 
 export const deserializeRole = (role: RoleEventResponse): RoleEvent => ({
   object: 'role',