Add customAttributes field to SSO Profile (#1261)

Author: mattgd

src/common/interfaces/unknown-record.interface.ts

@@ -0,0 +1 @@
+export type UnknownRecord = Record<string, unknown>;

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

@@ -29,6 +29,9 @@ exports[`SSO SSO getProfileAndToken with all information provided sends a reques
 {
   "connectionId": "conn_123",
   "connectionType": "OktaSAML",
+  "customAttributes": {
+    "license": "professional",
+  },
   "email": "[email protected]",
   "firstName": "foo",
   "groups": [
@@ -47,6 +50,7 @@ exports[`SSO SSO getProfileAndToken with all information provided sends a reques
       "Developers",
     ],
     "last_name": "bar",
+    "license": "professional",
   },
   "role": {
     "slug": "admin",
@@ -69,6 +73,7 @@ exports[`SSO SSO getProfileAndToken without a groups attribute sends a request t
 {
   "connectionId": "conn_123",
   "connectionType": "OktaSAML",
+  "customAttributes": {},
   "email": "[email protected]",
   "firstName": "foo",
   "groups": undefined,

src/sso/interfaces/profile-and-token.interface.ts

@@ -1,11 +1,14 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { Profile, ProfileResponse } from './profile.interface';
 
-export interface ProfileAndToken {
+export interface ProfileAndToken<CustomAttributesType extends UnknownRecord> {
   accessToken: string;
-  profile: Profile;
+  profile: Profile<CustomAttributesType>;
 }
 
-export interface ProfileAndTokenResponse {
+export interface ProfileAndTokenResponse<
+  CustomAttributesType extends UnknownRecord,
+> {
   access_token: string;
-  profile: ProfileResponse;
+  profile: ProfileResponse<CustomAttributesType>;
 }

src/sso/interfaces/profile.interface.ts

@@ -1,7 +1,8 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { RoleResponse } from '../../roles/interfaces';
 import { ConnectionType } from './connection-type.enum';
 
-export interface Profile {
+export interface Profile<CustomAttributesType extends UnknownRecord> {
   id: string;
   idpId: string;
   organizationId?: string;
@@ -12,10 +13,11 @@ export interface Profile {
   lastName?: string;
   role?: RoleResponse;
   groups?: string[];
+  customAttributes?: CustomAttributesType;
   rawAttributes?: { [key: string]: any };
 }
 
-export interface ProfileResponse {
+export interface ProfileResponse<CustomAttributesType extends UnknownRecord> {
   id: string;
   idp_id: string;
   organization_id?: string;
@@ -26,5 +28,6 @@ export interface ProfileResponse {
   last_name?: string;
   role?: RoleResponse;
   groups?: string[];
+  custom_attributes?: CustomAttributesType;
   raw_attributes?: { [key: string]: any };
 }

src/sso/serializers/profile-and-token.serializer.ts

@@ -1,9 +1,12 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { ProfileAndToken, ProfileAndTokenResponse } from '../interfaces';
 import { deserializeProfile } from './profile.serializer';
 
-export const deserializeProfileAndToken = (
-  profileAndToken: ProfileAndTokenResponse,
-): ProfileAndToken => ({
+export const deserializeProfileAndToken = <
+  CustomAttributesType extends UnknownRecord,
+>(
+  profileAndToken: ProfileAndTokenResponse<CustomAttributesType>,
+): ProfileAndToken<CustomAttributesType> => ({
   accessToken: profileAndToken.access_token,
   profile: deserializeProfile(profileAndToken.profile),
 });

src/sso/serializers/profile.serializer.ts

@@ -1,6 +1,9 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { Profile, ProfileResponse } from '../interfaces';
 
-export const deserializeProfile = (profile: ProfileResponse): Profile => ({
+export const deserializeProfile = <CustomAttributesType extends UnknownRecord>(
+  profile: ProfileResponse<CustomAttributesType>,
+): Profile<CustomAttributesType> => ({
   id: profile.id,
   idpId: profile.idp_id,
   organizationId: profile.organization_id,
@@ -11,5 +14,6 @@ export const deserializeProfile = (profile: ProfileResponse): Profile => ({
   lastName: profile.last_name,
   role: profile.role,
   groups: profile.groups,
+  customAttributes: profile.custom_attributes,
   rawAttributes: profile.raw_attributes,
 });

src/sso/sso.spec.ts

@@ -218,6 +218,10 @@ describe('SSO', () => {
                 first_name: 'foo',
                 last_name: 'bar',
                 groups: ['Admins', 'Developers'],
+                license: 'professional',
+              },
+              custom_attributes: {
+                license: 'professional',
               },
             },
           });
@@ -258,6 +262,7 @@ describe('SSO', () => {
                 first_name: 'foo',
                 last_name: 'bar',
               },
+              custom_attributes: {},
             },
           });
 
@@ -298,6 +303,7 @@ describe('SSO', () => {
             last_name: 'bar',
             groups: ['Admins', 'Developers'],
           },
+          custom_attributes: {},
         });
 
         const workos = new WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');

src/sso/sso.ts

@@ -19,6 +19,7 @@ import {
   serializeListConnectionsOptions,
 } from './serializers';
 import { fetchAndDeserialize } from '../common/utils/fetch-and-deserialize';
+import { UnknownRecord } from '../common/interfaces/unknown-record.interface';
 
 const toQueryString = (options: Record<string, string | undefined>): string => {
   const searchParams = new URLSearchParams();
@@ -109,27 +110,34 @@ export class SSO {
     return deserializeConnection(data);
   }
 
-  async getProfileAndToken({
+  async getProfileAndToken<
+    CustomAttributesType extends UnknownRecord = UnknownRecord,
+  >({
     code,
     clientId,
-  }: GetProfileAndTokenOptions): Promise<ProfileAndToken> {
+  }: GetProfileAndTokenOptions): Promise<
+    ProfileAndToken<CustomAttributesType>
+  > {
     const form = new URLSearchParams({
       client_id: clientId,
       client_secret: this.workos.key as string,
       grant_type: 'authorization_code',
       code,
     });
 
-    const { data } = await this.workos.post<ProfileAndTokenResponse>(
-      '/sso/token',
-      form,
-    );
+    const { data } = await this.workos.post<
+      ProfileAndTokenResponse<CustomAttributesType>
+    >('/sso/token', form);
 
     return deserializeProfileAndToken(data);
   }
 
-  async getProfile({ accessToken }: GetProfileOptions): Promise<Profile> {
-    const { data } = await this.workos.get<ProfileResponse>('/sso/profile', {
+  async getProfile<CustomAttributesType extends UnknownRecord = UnknownRecord>({
+    accessToken,
+  }: GetProfileOptions): Promise<Profile<CustomAttributesType>> {
+    const { data } = await this.workos.get<
+      ProfileResponse<CustomAttributesType>
+    >('/sso/profile', {
       accessToken,
     });