Merge pull request #232 from HubSpot/bash/add-fixtures-to-fetch-scope…

…-authorization feat: add fixtures to fetch scope authorization data per portal and user
HubSpot · Feb 5, 2025 · 84bb99c · 84bb99c
2 parents 19a88a6 + f49c02d
commit 84bb99c
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/api/localDevAuth.ts b/api/localDevAuth.ts
@@ -6,6 +6,7 @@ import {
   ScopeData,
   AccessTokenResponse,
   EnabledFeaturesResponse,
+  ScopeAuthorizationResponse,
 } from '../types/Accounts';
 import axios from 'axios';
 import { PublicAppInstallationData } from '../types/Apps';
@@ -44,6 +45,14 @@ export function fetchScopeData(
   });
 }
 
+export async function fetchScopeAuthorizationData(
+  accountId: number
+): HubSpotPromise<ScopeAuthorizationResponse> {
+  return http.get<ScopeAuthorizationResponse>(accountId, {
+    url: `${LOCALDEVAUTH_API_AUTH_PATH}/scope-groups/authorized`,
+  });
+}
+
 export function fetchAppInstallationData(
   portalId: number,
   projectId: number,

diff --git a/lib/personalAccessKey.ts b/lib/personalAccessKey.ts
@@ -1,9 +1,9 @@
 import moment from 'moment';
 import { ENVIRONMENTS } from '../constants/environments';
 import { PERSONAL_ACCESS_KEY_AUTH_METHOD } from '../constants/auth';
-import { fetchAccessToken } from '../api/localDevAuth';
+import { fetchAccessToken, fetchScopeAuthorizationData } from '../api/localDevAuth';
 import { fetchSandboxHubData } from '../api/sandboxHubs';
-import { CLIAccount, PersonalAccessKeyAccount } from '../types/Accounts';
+import { CLIAccount, PersonalAccessKeyAccount, ScopeGroupAuthorization } from '../types/Accounts';
 import { Environment } from '../types/Config';
 import {
   getAccountConfig,
@@ -168,6 +168,12 @@ export async function scopesOnAccessToken(
   return (await getNewAccessTokenByAccountId(accountId)).scopeGroups;
 }
 
+export async function authorizedScopesForPortalAndUser(
+  accountId: number
+): Promise<Array<ScopeGroupAuthorization>> {
+  return (await fetchScopeAuthorizationData(accountId)).data.results;
+}
+
 export async function updateConfigWithAccessToken(
   token: AccessToken,
   personalAccessKey: string,

diff --git a/types/Accounts.ts b/types/Accounts.ts
@@ -132,6 +132,22 @@ export type ScopeData = {
   userScopesInGroup: Array<string>;
 };
 
+export type ScopeAuthorizationResponse = {
+  results: Array<ScopeGroupAuthorization>;
+}
+
+export type ScopeGroupAuthorization = {
+  scopeGroup: ScopeGroup;
+  portalAuthorized: boolean;
+  userAuthorized: boolean;
+}
+
+export type ScopeGroup = {
+  name: string;
+  shortDescription: string;
+  longDescription: string;
+}
+
 export type AccessTokenResponse = {
   hubId: number;
   userId: number;