feat: Add name field to Profile, User, and Actions interfaces

src/actions/actions.spec.ts

@@ -121,6 +121,7 @@ describe('Actions', () => {
           object: 'user',
           id: '01JATCHZVEC5EPANDPEZVM68Y9',
           email: 'jane@foocorp.com',
+          name: 'Jane Doe',
           firstName: 'Jane',
           lastName: 'Doe',
           emailVerified: true,
@@ -178,6 +179,7 @@ describe('Actions', () => {
         userData: {
           object: 'user_data',
           email: 'jane@foocorp.com',
+          name: 'Jane Doe',
           firstName: 'Jane',
           lastName: 'Doe',
         },

src/actions/fixtures/authentication-action-context.json

@@ -4,6 +4,7 @@
         "object": "user",
         "id": "01JATCHZVEC5EPANDPEZVM68Y9",
         "email": "jane@foocorp.com",
+        "name": "Jane Doe",
         "first_name": "Jane",
         "last_name": "Doe",
         "email_verified": true,

src/actions/fixtures/user-registration-action-context.json

@@ -3,6 +3,7 @@
     "user_data": {
         "object": "user_data",
         "email": "jane@foocorp.com",
+        "name": "Jane Doe",
         "first_name": "Jane",
         "last_name": "Doe"
     },

src/actions/interfaces/action.interface.ts

@@ -26,6 +26,7 @@ interface AuthenticationActionContext {
 export interface UserData {
   object: 'user_data';
   email: string;
+  name: string | null;
   firstName: string;
   lastName: string;
 }
@@ -59,6 +60,7 @@ interface AuthenticationActionPayload {
 export interface UserDataPayload {
   object: 'user_data';
   email: string;
+  name: string | null;
   first_name: string;
   last_name: string;
 }

src/actions/serializers/action.serializer.ts

@@ -15,6 +15,7 @@ const deserializeUserData = (userData: UserDataPayload): UserData => {
   return {
     object: userData.object,
     email: userData.email,
+    name: userData.name ?? null,
     firstName: userData.first_name,
     lastName: userData.last_name,
   };

src/groups/fixtures/list-user-organization-membership-base-list-data.json

@@ -18,6 +18,7 @@
       "user": {
         "object": "user",
         "id": "user_01E4ZCR3C56J083X43JQXF3JK5",
+        "name": "Marcelina Davis",
         "first_name": "Marcelina",
         "last_name": "Davis",
         "profile_picture_url": "https://workoscdn.com/images/v1/123abc",

src/groups/fixtures/user-organization-membership-base-list-data.json

@@ -16,6 +16,7 @@
   "user": {
     "object": "user",
     "id": "user_01E4ZCR3C56J083X43JQXF3JK5",
+    "name": "Marcelina Davis",
     "first_name": "Marcelina",
     "last_name": "Davis",
     "profile_picture_url": "https://workoscdn.com/images/v1/123abc",

src/sso/__snapshots__/sso.spec.ts.snap

@@ -34,6 +34,7 @@ exports[`SSO SSO getProfileAndToken with all information provided sends a reques
   "id": "prof_123",
   "idpId": "123",
   "lastName": "bar",
+  "name": "foo bar",
   "organizationId": "org_123",
   "rawAttributes": {
     "email": "foo@test.com",
@@ -68,6 +69,7 @@ exports[`SSO SSO getProfileAndToken without a groups attribute sends a request t
   "id": "prof_123",
   "idpId": "123",
   "lastName": "bar",
+  "name": "foo bar",
   "organizationId": "org_123",
   "rawAttributes": {
     "email": "foo@test.com",

src/sso/interfaces/profile.interface.ts

@@ -15,6 +15,8 @@ export interface Profile<CustomAttributesType extends UnknownRecord> {
   connectionType: ConnectionType;
   /** The user's email address. */
   email: string;
+  /** The user's full name. */
+  name?: string;
   /** The user's first name. */
   firstName?: string;
   /** The user's last name. */
@@ -38,6 +40,7 @@ export interface ProfileResponse<CustomAttributesType extends UnknownRecord> {
   connection_id: string;
   connection_type: ConnectionType;
   email: string;
+  name?: string;
   first_name?: string;
   last_name?: string;
   role?: RoleResponse;

src/sso/serializers/profile.serializer.ts

@@ -12,6 +12,7 @@ export const deserializeProfile = <CustomAttributesType extends UnknownRecord>(
   connectionId: profile.connection_id,
   connectionType: profile.connection_type,
   email: profile.email,
+  ...(profile.name !== undefined && { name: profile.name }),
   ...(profile.first_name !== undefined && { firstName: profile.first_name }),
   ...(profile.last_name !== undefined && { lastName: profile.last_name }),
   ...(profile.role !== undefined && { role: profile.role }),

src/sso/sso.spec.ts

@@ -340,6 +340,7 @@ describe('SSO', () => {
               connection_id: 'conn_123',
               connection_type: 'OktaSAML',
               email: 'foo@test.com',
+              name: 'foo bar',
               first_name: 'foo',
               last_name: 'bar',
               role: {
@@ -398,6 +399,7 @@ describe('SSO', () => {
               connection_id: 'conn_123',
               connection_type: 'OktaSAML',
               email: 'foo@test.com',
+              name: 'foo bar',
               first_name: 'foo',
               last_name: 'bar',
               role: {
@@ -451,6 +453,7 @@ describe('SSO', () => {
               connection_id: 'conn_123',
               connection_type: 'OktaSAML',
               email: 'foo@test.com',
+              name: 'foo bar',
               first_name: 'foo',
               last_name: 'bar',
               role: {
@@ -504,6 +507,7 @@ describe('SSO', () => {
               connection_id: 'conn_123',
               connection_type: 'OktaSAML',
               email: 'foo@test.com',
+              name: 'foo bar',
               first_name: 'foo',
               last_name: 'bar',
               role: {
@@ -544,6 +548,7 @@ describe('SSO', () => {
               connection_id: 'conn_123',
               connection_type: 'OktaSAML',
               email: 'foo@test.com',
+              name: 'foo bar',
               first_name: 'foo',
               last_name: 'bar',
               role: { slug: 'admin' },
@@ -592,6 +597,7 @@ describe('SSO', () => {
               connection_id: 'conn_123',
               connection_type: 'OktaSAML',
               email: 'foo@test.com',
+              name: 'foo bar',
               first_name: 'foo',
               last_name: 'bar',
               role: { slug: 'admin' },
@@ -662,6 +668,7 @@ describe('SSO', () => {
           connection_id: 'conn_123',
           connection_type: 'OktaSAML',
           email: 'foo@test.com',
+          name: 'foo bar',
           first_name: 'foo',
           last_name: 'bar',
           role: {

src/user-management/fixtures/list-users.json

@@ -5,6 +5,7 @@
       "object": "user",
       "id": "user_01H5JQDV7R7ATEYZDEG0W5PRYS",
       "email": "test01@example.com",
+      "name": "Test 01 User",
       "first_name": "Test 01",
       "last_name": "User",
       "created_at": "2023-07-18T02:07:19.911Z",

src/user-management/fixtures/user.json

@@ -2,6 +2,7 @@
   "object": "user",
   "id": "user_01H5JQDV7R7ATEYZDEG0W5PRYS",
   "email": "test01@example.com",
+  "name": "Test 01 User",
   "first_name": "Test 01",
   "last_name": "User",
   "created_at": "2023-07-18T02:07:19.911Z",

src/user-management/interfaces/create-user-options.interface.ts

@@ -5,6 +5,7 @@ export interface CreateUserOptions {
   password?: string;
   passwordHash?: string;
   passwordHashType?: PasswordHashType;
+  name?: string;
   firstName?: string;
   lastName?: string;
   emailVerified?: boolean;
@@ -17,6 +18,7 @@ export interface SerializedCreateUserOptions {
   password?: string;
   password_hash?: string;
   password_hash_type?: PasswordHashType;
+  name?: string;
   first_name?: string;
   last_name?: string;
   email_verified?: boolean;

src/user-management/interfaces/update-user-options.interface.ts

@@ -3,6 +3,7 @@ import { PasswordHashType } from './password-hash-type.interface';
 export interface UpdateUserOptions {
   userId: string;
   email?: string;
+  name?: string;
   firstName?: string;
   lastName?: string;
   emailVerified?: boolean;
@@ -16,6 +17,7 @@ export interface UpdateUserOptions {
 
 export interface SerializedUpdateUserOptions {
   email?: string;
+  name?: string;
   first_name?: string;
   last_name?: string;
   email_verified?: boolean;

src/user-management/interfaces/user.interface.ts

@@ -10,6 +10,8 @@ export interface User {
   emailVerified: boolean;
   /** A URL reference to an image representing the user. */
   profilePictureUrl: string | null;
+  /** The full name of the user. */
+  name: string | null;
   /** The first name of the user. */
   firstName: string | null;
   /** The last name of the user. */
@@ -34,6 +36,7 @@ export interface UserResponse {
   email: string;
   email_verified: boolean;
   profile_picture_url: string | null;
+  name: string | null;
   first_name: string | null;
   last_name: string | null;
   last_sign_in_at: string | null;

src/user-management/serializers/create-user-options.serializer.ts

@@ -7,6 +7,7 @@ export const serializeCreateUserOptions = (
   password: options.password,
   password_hash: options.passwordHash,
   password_hash_type: options.passwordHashType,
+  name: options.name,
   first_name: options.firstName,
   last_name: options.lastName,
   email_verified: options.emailVerified,

src/user-management/serializers/update-user-options.serializer.ts

@@ -5,6 +5,7 @@ export const serializeUpdateUserOptions = (
 ): SerializedUpdateUserOptions => ({
   email: options.email,
   email_verified: options.emailVerified,
+  name: options.name,
   first_name: options.firstName,
   last_name: options.lastName,
   password: options.password,

src/user-management/serializers/user.serializer.ts

@@ -5,6 +5,7 @@ export const deserializeUser = (user: UserResponse): User => ({
   id: user.id,
   email: user.email,
   emailVerified: user.email_verified,
+  name: user.name ?? null,
   firstName: user.first_name,
   profilePictureUrl: user.profile_picture_url,
   lastName: user.last_name,

src/user-management/user-management.spec.ts

@@ -58,6 +58,7 @@ describe('UserManagement', () => {
         id: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
         email: 'test01@example.com',
         profilePictureUrl: 'https://example.com/profile_picture.jpg',
+        name: 'Test 01 User',
         firstName: 'Test 01',
         lastName: 'User',
         emailVerified: true,
@@ -81,6 +82,7 @@ describe('UserManagement', () => {
         id: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
         email: 'test01@example.com',
         profilePictureUrl: 'https://example.com/profile_picture.jpg',
+        name: 'Test 01 User',
         firstName: 'Test 01',
         lastName: 'User',
         emailVerified: true,
@@ -145,6 +147,7 @@ describe('UserManagement', () => {
       expect(user).toMatchObject({
         object: 'user',
         email: 'test01@example.com',
+        name: 'Test 01 User',
         firstName: 'Test 01',
         lastName: 'User',
         emailVerified: true,
@@ -1452,6 +1455,7 @@ describe('UserManagement', () => {
           createdAt: '2023-07-18T02:07:19.911Z',
           email: 'test01@example.com',
           emailVerified: true,
+          name: 'Test 01 User',
           firstName: 'Test 01',
           id: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
           lastName: 'User',