BREAKING CHANGE: support generic UserClaims type

OKTA-419985 <<<Jenkins Check-In of Tested SHA: a793ce8 for eng_productivity_ci_bot_okta@okta.com>>> Artifact: okta-auth-js Files changed count: 3 PR Link: "#1003"
okta · Jan 7, 2022 · b164572 · b164572
1 parent 43ba730
commit b164572
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/lib/types/UserClaims.ts b/lib/types/UserClaims.ts
@@ -18,7 +18,7 @@
  */
 
  /* eslint-disable camelcase */
-export interface UserClaims {
+export type UserClaims<T = {}> = T & {
   auth_time?: number;
   aud?: string;
   email?: string;
@@ -37,5 +37,5 @@ export interface UserClaims {
   updated_at?: number;
   ver?: number;
   zoneinfo?: string;
-  [propName: string]: any;  // For custom claims that may be configured by the org admin
+  at_hash?: string;
 }
diff --git a/test/apps/app/src/tokens.ts b/test/apps/app/src/tokens.ts
@@ -26,7 +26,7 @@ function tokensHTML(tokens: Tokens): string {
     </thead>
     <tbody>
     ${
-      Object.keys(claims).map((key) => {
+      Object.keys(claims).map((key: keyof UserClaims) => {
         return `<tr><td>${key}</td><td>${claims[key]}</td></tr>`;
       }).join('\n')
     }

diff --git a/test/types/auth.test-d.ts b/test/types/auth.test-d.ts
@@ -105,6 +105,10 @@ const authorizeOptions2: TokenParams = {
   // User
   expectType<boolean>(await authClient.isAuthenticated());
   expectType<UserClaims>(await authClient.getUser());
+  const user = { sub: 'sub', groups: ['fake group'] };
+  expectAssignable<UserClaims<{
+    groups: string[];
+  }>>(user);
 
   // Redirect
   expectType<boolean>(authClient.isLoginRedirect());