Use correct types for config and accounts

Author: kemmerle

src/lib/commands/account.ts

@@ -1,12 +1,12 @@
 import { commands, ExtensionContext, Uri } from 'vscode';
+import { CLIAccount_DEPRECATED } from '@hubspot/local-dev-lib/types/Accounts';
 import { COMMANDS } from '../constants';
-import { Portal } from '../types';
 
 export const registerCommands = (context: ExtensionContext) => {
   context.subscriptions.push(
     commands.registerCommand(
       COMMANDS.ACCOUNT.VIEW_PERSONAL_ACCESS_KEY,
-      async (hubspotAccount: Portal) => {
+      async (hubspotAccount: CLIAccount_DEPRECATED) => {
         const pakUrl = `https://app.hubspot${
           hubspotAccount.env === 'qa' ? 'qa' : ''
         }.com/personal-access-key/${hubspotAccount.portalId}`;
@@ -18,7 +18,7 @@ export const registerCommands = (context: ExtensionContext) => {
   context.subscriptions.push(
     commands.registerCommand(
       COMMANDS.ACCOUNT.OPEN_DESIGN_MANAGER,
-      async (hubspotAccount: Portal) => {
+      async (hubspotAccount: CLIAccount_DEPRECATED) => {
         const designManagerUrl = `https://app.hubspot${
           hubspotAccount.env === 'qa' ? 'qa' : ''
         }.com/design-manager/${hubspotAccount.portalId}`;

src/lib/commands/config.ts

@@ -2,7 +2,6 @@ import { commands, window, ExtensionContext } from 'vscode';
 import { updateStatusBarItems } from '../statusBar';
 import { COMMANDS, TRACKED_EVENTS } from '../constants';
 import { getDisplayedHubspotPortalInfo } from '../helpers';
-import { Portal } from '../types';
 import { portalNameInvalid } from '../validation';
 import { trackEvent } from '../tracking';
 import { showAutoDismissedStatusBarMessage } from '../messaging';
@@ -13,24 +12,31 @@ import {
   renameAccount,
   updateDefaultAccount,
 } from '@hubspot/local-dev-lib/config';
+import { CLIConfig } from '@hubspot/local-dev-lib/types/Config';
+import { CLIAccount_DEPRECATED } from '@hubspot/local-dev-lib/types/Accounts';
 
-const showRenameAccountPrompt = (accountToRename: Portal) => {
+const showRenameAccountPrompt = (accountToRename: CLIAccount_DEPRECATED) => {
   window
     .showInputBox({
       placeHolder: 'Enter a new name for the account',
     })
     .then(async (newName: string | undefined) => {
       if (newName) {
         const oldName = accountToRename.name || accountToRename.portalId;
-        const config = getConfig();
+        const config: CLIConfig | null = getConfig();
         let invalidReason = '';
         if (config) {
-          // @ts-expect-error TODO: Fix this when updating local-dev-lib
           invalidReason = portalNameInvalid(newName, config);
         }
 
         if (!invalidReason) {
-          renameAccount(oldName, newName);
+          if (!oldName) {
+            window.showErrorMessage(
+              'Could not determine account name to rename'
+            );
+            return;
+          }
+          renameAccount(String(oldName), newName);
           showAutoDismissedStatusBarMessage(
             `Successfully renamed default account from ${oldName} to ${newName}.`
           );
@@ -76,19 +82,16 @@ export const registerCommands = (context: ExtensionContext) => {
     commands.registerCommand(
       COMMANDS.CONFIG.SELECT_DEFAULT_ACCOUNT,
       async () => {
-        const config = getConfig();
-        // @ts-expect-error TODO: Fix this when updating local-dev-lib
-        if (config && config.portals) {
+        const config: CLIConfig | null = getConfig();
+
+        if (config && 'portals' in config && config.portals) {
           window
             .showQuickPick(
-              // @ts-expect-error TODO: Fix this when updating local-dev-lib
-              config.portals.map((p: Portal) => {
+              config.portals.map((p: CLIAccount_DEPRECATED) => {
                 return {
                   label: getDisplayedHubspotPortalInfo(p),
                   description:
-                    // @ts-expect-error TODO: Fix this when updating local-dev-lib
                     config.defaultPortal === p.portalId ||
-                    // @ts-expect-error TODO: Fix this when updating local-dev-lib
                     config.defaultPortal === p.name
                       ? '(default)'
                       : '',
@@ -102,8 +105,13 @@ export const registerCommands = (context: ExtensionContext) => {
             .then(async (selection) => {
               if (selection) {
                 const newDefaultAccount =
-                  // @ts-ignore selection is an object
                   selection.portal.name || selection.portal.portalId;
+                if (!newDefaultAccount) {
+                  window.showErrorMessage(
+                    'No account selected; Choose an account to set as default'
+                  );
+                  return;
+                }
                 await trackEvent(TRACKED_EVENTS.SELECT_DEFAULT_ACCOUNT);
                 updateDefaultAccount(newDefaultAccount);
                 showAutoDismissedStatusBarMessage(
@@ -142,8 +150,11 @@ export const registerCommands = (context: ExtensionContext) => {
           )
           .then(async (answer) => {
             if (answer === 'Yes') {
-              // @ts-expect-error TODO: Fix this when updating local-dev-lib
-              if (config && config.portals.length === 1) {
+              if (
+                config &&
+                'portals' in config &&
+                config.portals.length === 1
+              ) {
                 deleteConfigFile();
                 showAutoDismissedStatusBarMessage(
                   `Successfully deleted account ${accountIdentifier}. The config file has been deleted because there are no more authenticated accounts.`

src/lib/helpers.ts

@@ -3,7 +3,8 @@ import { window, commands, workspace, StatusBarAlignment } from 'vscode';
 import { getAccountId } from '@hubspot/local-dev-lib/config';
 
 import { COMMANDS } from './constants';
-import { HubspotConfig, Portal } from './types';
+import { CLIConfig } from '@hubspot/local-dev-lib/types/Config';
+import { CLIAccount_DEPRECATED } from '@hubspot/local-dev-lib/types/Accounts';
 
 const { exec } = require('node:child_process');
 
@@ -16,18 +17,21 @@ export const getRootPath = () => {
   return workspaceFolders[0].uri.fsPath;
 };
 
-export const getDefaultPortalFromConfig = (config: HubspotConfig) => {
+export const getDefaultPortalFromConfig = (config: CLIConfig) => {
   return (
     config &&
+    'portals' in config &&
     config.portals &&
     config.portals.find(
-      (p: Portal) =>
+      (p: CLIAccount_DEPRECATED) =>
         p.portalId === config.defaultPortal || p.name === config.defaultPortal
     )
   );
 };
 
-export const getDisplayedHubspotPortalInfo = (portalData: Portal) => {
+export const getDisplayedHubspotPortalInfo = (
+  portalData: CLIAccount_DEPRECATED
+) => {
   return portalData.name
     ? `${portalData.name} - ${portalData.portalId}`
     : `${portalData.portalId}`;

src/lib/providers/treedata/accounts.ts

@@ -7,18 +7,24 @@ import {
   TreeItemCollapsibleState,
 } from 'vscode';
 import { getDisplayedHubspotPortalInfo } from '../../helpers';
-import { HubspotConfig, Portal } from '../../types';
 
 import { getConfig } from '@hubspot/local-dev-lib/config';
+import { CLIConfig } from '@hubspot/local-dev-lib/types/Config';
+import { CLIAccount_DEPRECATED } from '@hubspot/local-dev-lib/types/Accounts';
 
-const isDefaultPortal = (portal: Portal, config: HubspotConfig) => {
+const isDefaultPortal = (
+  portal: CLIAccount_DEPRECATED,
+  config: CLIConfig | null
+) => {
   return (
-    config.defaultPortal === portal.portalId ||
-    config.defaultPortal === portal.name
+    config &&
+    'defaultPortal' in config &&
+    (config.defaultPortal === portal.portalId ||
+      config.defaultPortal === portal.name)
   );
 };
 
-const getAccountIdentifiers = (portal: Portal) => {
+const getAccountIdentifiers = (portal: CLIAccount_DEPRECATED) => {
   let accountIdentifiers = '';
 
   if (portal.env === 'qa') {
@@ -28,10 +34,11 @@ const getAccountIdentifiers = (portal: Portal) => {
   return accountIdentifiers;
 };
 
-export class AccountsProvider implements TreeDataProvider<Portal> {
-  private config: HubspotConfig | null;
+export class AccountsProvider
+  implements TreeDataProvider<CLIAccount_DEPRECATED>
+{
+  private config: CLIConfig | null;
   constructor() {
-    // @ts-expect-error TODO: Fix this when updating local-dev-lib
     this.config = getConfig();
   }
 
@@ -43,24 +50,22 @@ export class AccountsProvider implements TreeDataProvider<Portal> {
     this._onDidChangeTreeData.fire(undefined);
   }
 
-  getTreeItem(p: Portal): TreeItem {
+  getTreeItem(p: CLIAccount_DEPRECATED): TreeItem {
     const identifiers = getAccountIdentifiers(p);
     const name = `${getDisplayedHubspotPortalInfo(p)} ${identifiers}`;
     return new AccountTreeItem(
       name,
       p,
-      // @ts-expect-error TODO: Fix this when updating local-dev-lib
-      { isDefault: isDefaultPortal(p, this.config) },
+      { isDefault: isDefaultPortal(p, this.config) ?? false },
       TreeItemCollapsibleState.None
     );
   }
 
-  getChildren(): Thenable<Portal[] | undefined> {
+  getChildren(): Thenable<CLIAccount_DEPRECATED[] | undefined> {
     console.log('AccountsProvider:getChildren');
-    // @ts-expect-error TODO: Fix this when updating local-dev-lib
     this.config = getConfig();
 
-    if (this.config && this.config.portals) {
+    if (this.config && 'portals' in this.config && this.config.portals) {
       return Promise.resolve(this.config.portals);
     }
 
@@ -71,7 +76,7 @@ export class AccountsProvider implements TreeDataProvider<Portal> {
 export class AccountTreeItem extends TreeItem {
   constructor(
     public readonly name: string,
-    public readonly portalData: Portal,
+    public readonly portalData: CLIAccount_DEPRECATED,
     public readonly options: { isDefault: boolean },
     public readonly collapsibleState: TreeItemCollapsibleState,
     public iconPath: ThemeIcon = new ThemeIcon('account'),

src/lib/types.ts

@@ -1,34 +1,5 @@
 import { Command } from 'vscode';
 
-export interface Portal {
-  name: string;
-  portalId: string;
-  authType: string;
-  auth: {
-    clientId: string;
-    clientSecret: string;
-    scopes: string[];
-    tokenInfo: {
-      accessToken: string;
-      expiresAt: number;
-      refreshToken: string;
-    };
-  };
-  personalAccessKey: string;
-  env?: string;
-  sandboxAccountType?: string;
-  parentAccountId?: number;
-}
-
-export interface HubspotConfig {
-  defaultPortal: string;
-  portals: Array<Portal>;
-  defaultMode?: 'draft' | 'published' | undefined;
-  httpTimeout?: number | undefined;
-  allowUsageTracking?: boolean | undefined;
-  useCustomObjectHubFile?: boolean | undefined;
-}
-
 export interface Link {
   label: string;
   url: string;

src/lib/uri.ts

@@ -20,13 +20,8 @@ import {
   createEmptyConfigFile,
   setConfigPath,
 } from '@hubspot/local-dev-lib/config';
-
-// TODO: Remove these once we've updated local-dev-lib
-const ENVIRONMENTS = {
-  PROD: 'prod',
-  QA: 'qa',
-} as const;
-type ValueOf<T> = T[keyof T];
+import { ENVIRONMENTS } from '@hubspot/local-dev-lib/constants/environments';
+import { Environment } from '@hubspot/local-dev-lib/types/Config';
 
 const getQueryObject = (uri: Uri) => {
   return new URLSearchParams(uri.query);
@@ -35,7 +30,7 @@ const getQueryObject = (uri: Uri) => {
 const handleAuthRequest = async (authParams: URLSearchParams) => {
   const personalAccessKeyResp = authParams.get('personalAccessKeyResp') || '';
   const envParam = authParams.get('env');
-  const env: ValueOf<typeof ENVIRONMENTS> =
+  const env: Environment =
     envParam === ENVIRONMENTS.QA ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD;
   const name = authParams.get('name') || undefined;
   const portalId = authParams.get('portalId');

src/lib/validation.ts

@@ -7,7 +7,8 @@ import {
   Diagnostic,
   Range,
 } from 'vscode';
-import { HubspotConfig } from './types';
+import { CLIConfig } from '@hubspot/local-dev-lib/types/Config';
+import { CLIAccount } from '@hubspot/local-dev-lib/types/Accounts';
 import { HubLValidationError } from '@hubspot/local-dev-lib/types/HublValidation';
 import { validateHubl } from '@hubspot/local-dev-lib/api/validateHubl';
 import { getAccountId } from '@hubspot/local-dev-lib/config';
@@ -174,7 +175,7 @@ export const triggerValidate = (
 
 export const portalNameInvalid = (
   portalName: string,
-  config: HubspotConfig
+  config: CLIConfig | null
 ) => {
   if (typeof portalName !== 'string') {
     return 'Portal name must be a string';
@@ -184,9 +185,10 @@ export const portalNameInvalid = (
     return 'Portal name cannot contain spaces';
   }
   return config &&
+    'portals' in config &&
     (config.portals || [])
-      .map((p) => p.name)
-      .find((name) => name === portalName)
+      .map((p: CLIAccount) => p.name)
+      .find((name: string | undefined) => name === portalName)
     ? `${portalName} already exists in config.`
-    : false;
+    : '';
 };