@hubspot/local-dev-lib 3.21.2 → 4.0.0

package/types/Accounts.d.ts

@@ -2,45 +2,20 @@ import { HUBSPOT_ACCOUNT_TYPES } from '../constants/config';
 import { CmsPublishMode } from './Files';
 import { Environment } from './Config';
 import { ValueOf } from './Utils';
+import { PERSONAL_ACCESS_KEY_AUTH_METHOD, OAUTH_AUTH_METHOD, API_KEY_AUTH_METHOD } from '../constants/auth';
 export type AuthType = 'personalaccesskey' | 'apikey' | 'oauth2';
-export interface CLIAccount_NEW {
-    name?: string;
+interface BaseHubSpotConfigAccount {
+    name: string;
     accountId: number;
     accountType?: AccountType;
     defaultCmsPublishMode?: CmsPublishMode;
     env: Environment;
-    authType?: AuthType;
-    auth?: {
-        tokenInfo?: TokenInfo;
-        clientId?: string;
-        clientSecret?: string;
-    };
-    sandboxAccountType?: string | null;
-    parentAccountId?: number | null;
-    apiKey?: string;
-    personalAccessKey?: string;
-}
-export interface CLIAccount_DEPRECATED {
-    name?: string;
-    portalId?: number;
-    defaultCmsPublishMode?: CmsPublishMode;
-    env: Environment;
-    accountType?: AccountType;
-    authType?: AuthType;
-    auth?: {
-        tokenInfo?: TokenInfo;
-        clientId?: string;
-        clientSecret?: string;
-    };
-    sandboxAccountType?: string | null;
-    parentAccountId?: number | null;
-    apiKey?: string;
-    personalAccessKey?: string;
+    authType: AuthType;
+    parentAccountId?: number;
 }
-export type CLIAccount = CLIAccount_NEW | CLIAccount_DEPRECATED;
-export type GenericAccount = {
+export type DeprecatedHubSpotConfigAccountFields = {
     portalId?: number;
-    accountId?: number;
+    sandboxAccountType?: string;
 };
 export type AccountType = ValueOf<typeof HUBSPOT_ACCOUNT_TYPES>;
 export type TokenInfo = {
@@ -48,60 +23,27 @@ export type TokenInfo = {
     expiresAt?: string;
     refreshToken?: string;
 };
-export interface PersonalAccessKeyAccount_NEW extends CLIAccount_NEW {
-    authType: 'personalaccesskey';
-    personalAccessKey: string;
-}
-export interface PersonalAccessKeyAccount_DEPRECATED extends CLIAccount_DEPRECATED {
-    authType: 'personalaccesskey';
+export interface PersonalAccessKeyConfigAccount extends BaseHubSpotConfigAccount {
+    authType: typeof PERSONAL_ACCESS_KEY_AUTH_METHOD.value;
     personalAccessKey: string;
-}
-export type PersonalAccessKeyAccount = PersonalAccessKeyAccount_NEW | PersonalAccessKeyAccount_DEPRECATED;
-export interface OAuthAccount_NEW extends CLIAccount_NEW {
-    authType: 'oauth2';
     auth: {
-        clientId?: string;
-        clientSecret?: string;
-        scopes?: Array<string>;
-        tokenInfo?: TokenInfo;
+        tokenInfo: TokenInfo;
     };
 }
-export interface OAuthAccount_DEPRECATED extends CLIAccount_DEPRECATED {
-    authType: 'oauth2';
+export interface OAuthConfigAccount extends BaseHubSpotConfigAccount {
+    authType: typeof OAUTH_AUTH_METHOD.value;
     auth: {
-        clientId?: string;
-        clientSecret?: string;
-        scopes?: Array<string>;
-        tokenInfo?: TokenInfo;
+        clientId: string;
+        clientSecret: string;
+        scopes: Array<string>;
+        tokenInfo: TokenInfo;
     };
 }
-export type OAuthAccount = OAuthAccount_NEW | OAuthAccount_DEPRECATED;
-export interface APIKeyAccount_NEW extends CLIAccount_NEW {
-    authType: 'apikey';
+export interface APIKeyConfigAccount extends BaseHubSpotConfigAccount {
+    authType: typeof API_KEY_AUTH_METHOD.value;
     apiKey: string;
 }
-export interface APIKeyAccount_DEPRECATED extends CLIAccount_DEPRECATED {
-    authType: 'apikey';
-    apiKey: string;
-}
-export type APIKeyAccount = APIKeyAccount_NEW | APIKeyAccount_DEPRECATED;
-export interface FlatAccountFields_NEW extends CLIAccount_NEW {
-    tokenInfo?: TokenInfo;
-    clientId?: string;
-    clientSecret?: string;
-    scopes?: Array<string>;
-    apiKey?: string;
-    personalAccessKey?: string;
-}
-export interface FlatAccountFields_DEPRECATED extends CLIAccount_DEPRECATED {
-    tokenInfo?: TokenInfo;
-    clientId?: string;
-    clientSecret?: string;
-    scopes?: Array<string>;
-    apiKey?: string;
-    personalAccessKey?: string;
-}
-export type FlatAccountFields = FlatAccountFields_NEW | FlatAccountFields_DEPRECATED;
+export type HubSpotConfigAccount = PersonalAccessKeyConfigAccount | OAuthConfigAccount | APIKeyConfigAccount;
 export type ScopeData = {
     portalScopesInGroup: Array<string>;
     userScopesInGroup: Array<string>;
@@ -137,27 +79,6 @@ export type EnabledFeaturesResponse = {
         [key: string]: boolean;
     };
 };
-export type UpdateAccountConfigOptions = Partial<FlatAccountFields_DEPRECATED> & {
-    environment?: Environment;
-};
-export type PersonalAccessKeyOptions = {
-    accountId: number;
-    personalAccessKey: string;
-    env: Environment;
-};
-export type OAuthOptions = {
-    accountId: number;
-    clientId: string;
-    clientSecret: string;
-    refreshToken: string;
-    scopes: Array<string>;
-    env: Environment;
-};
-export type APIKeyOptions = {
-    accountId: number;
-    apiKey: string;
-    env: Environment;
-};
 export type AccessToken = {
     portalId: number;
     accessToken: string;
@@ -170,17 +91,6 @@ export type AccessToken = {
     hubName: string;
     accountType: ValueOf<typeof HUBSPOT_ACCOUNT_TYPES>;
 };
-export type OAuth2ManagerAccountConfig = {
-    name?: string;
-    accountId?: number;
-    clientId?: string;
-    clientSecret?: string;
-    scopes?: Array<string>;
-    env?: Environment;
-    environment?: Environment;
-    tokenInfo?: TokenInfo;
-    authType?: 'oauth2';
-};
 export type WriteTokenInfoFunction = (tokenInfo: TokenInfo) => void;
 export type RefreshTokenResponse = {
     refresh_token: string;
@@ -193,3 +103,4 @@ export type ExchangeProof = {
     client_secret?: string;
     refresh_token?: string;
 };
+export {};

package/types/Config.d.ts

@@ -1,49 +1,40 @@
+import { CONFIG_FLAGS, HUBSPOT_CONFIG_ERROR_TYPES, HUBSPOT_CONFIG_OPERATIONS } from '../constants/config';
 import { ENVIRONMENTS } from '../constants/environments';
-import { CLIAccount_NEW, CLIAccount_DEPRECATED } from './Accounts';
+import { DeprecatedHubSpotConfigAccountFields, HubSpotConfigAccount } from './Accounts';
 import { CmsPublishMode } from './Files';
 import { ValueOf } from './Utils';
-export interface CLIConfig_NEW {
-    accounts?: Array<CLIAccount_NEW>;
+export interface HubSpotConfig {
+    accounts: Array<HubSpotConfigAccount>;
     allowUsageTracking?: boolean;
     allowAutoUpdates?: boolean;
-    defaultAccount?: string | number;
+    defaultAccount?: number;
     defaultMode?: CmsPublishMode;
     defaultCmsPublishMode?: CmsPublishMode;
     httpTimeout?: number;
     env?: Environment;
     httpUseLocalhost?: boolean;
     autoOpenBrowser?: boolean;
+    useCustomObjectHubfile?: boolean;
     flags?: Array<string>;
 }
-export interface CLIConfig_DEPRECATED {
-    portals: Array<CLIAccount_DEPRECATED>;
-    allowUsageTracking?: boolean;
-    allowAutoUpdates?: boolean;
-    defaultPortal?: string | number;
+export type DeprecatedHubSpotConfigFields = {
+    portals?: Array<HubSpotConfigAccount & DeprecatedHubSpotConfigAccountFields>;
+    defaultPortal?: string;
     defaultMode?: CmsPublishMode;
-    defaultCmsPublishMode?: CmsPublishMode;
-    httpTimeout?: number;
-    env?: Environment;
-    httpUseLocalhost?: boolean;
-    autoOpenBrowser?: boolean;
-    flags?: Array<string>;
-}
-export type CLIConfig = CLIConfig_NEW | CLIConfig_DEPRECATED;
-export type Environment = ValueOf<typeof ENVIRONMENTS> | '';
-export type EnvironmentConfigVariables = {
-    apiKey?: string;
-    clientId?: string;
-    clientSecret?: string;
-    personalAccessKey?: string;
-    accountId?: number;
-    refreshToken?: string;
-    env?: Environment;
 };
+export type Environment = ValueOf<typeof ENVIRONMENTS> | '';
 export type GitInclusionResult = {
     inGit: boolean;
     configIgnored: boolean;
     gitignoreFiles: Array<string>;
 };
+export type ConfigFlag = ValueOf<typeof CONFIG_FLAGS>;
 export type HubSpotState = {
     mcpTotalToolCalls: number;
 };
+export type HubSpotConfigErrorType = ValueOf<typeof HUBSPOT_CONFIG_ERROR_TYPES>;
+export type HubSpotConfigOperation = ValueOf<typeof HUBSPOT_CONFIG_OPERATIONS>;
+export type HubSpotConfigValidationResult = {
+    isValid: boolean;
+    errors: Array<string>;
+};

package/config/CLIConfiguration.d.ts

@@ -1,72 +0,0 @@
-import { CLIConfig_NEW, Environment } from '../types/Config';
-import { CLIAccount_NEW, FlatAccountFields_NEW, AccountType } from '../types/Accounts';
-import { CLIOptions } from '../types/CLIOptions';
-import { CmsPublishMode } from '../types/Files';
-declare class _CLIConfiguration {
-    options: CLIOptions;
-    useEnvConfig: boolean;
-    config: CLIConfig_NEW | null;
-    active: boolean;
-    constructor();
-    setActive(isActive: boolean): void;
-    isActive(): boolean;
-    init(options?: CLIOptions): CLIConfig_NEW | null;
-    load(): CLIConfig_NEW | null;
-    configIsEmpty(): boolean;
-    delete(): void;
-    write(updatedConfig?: CLIConfig_NEW): CLIConfig_NEW | null;
-    validate(): boolean;
-    getAccount(nameOrId: string | number | undefined): CLIAccount_NEW | null;
-    isConfigFlagEnabled(flag: keyof CLIConfig_NEW, defaultValue?: boolean): boolean;
-    getAccountId(nameOrId?: string | number): number | null;
-    getDefaultAccount(): string | number | null;
-    getDefaultAccountOverrideFilePath(): string | null;
-    getCWDAccountOverride(): string | number | null;
-    getAccountIndex(accountId: number): number;
-    getConfigAccounts(): Array<CLIAccount_NEW> | null;
-    isAccountInConfig(nameOrId: string | number): boolean;
-    getAndLoadConfigIfNeeded(options?: CLIOptions): CLIConfig_NEW;
-    getEnv(nameOrId?: string | number): Environment;
-    getAccountType(accountType?: AccountType | null, sandboxAccountType?: string | null): AccountType;
-    /**
-     * @throws {Error}
-     */
-    addOrUpdateAccount(updatedAccountFields: Partial<FlatAccountFields_NEW>, writeUpdate?: boolean): FlatAccountFields_NEW | null;
-    /**
-     * @throws {Error}
-     */
-    updateDefaultAccount(defaultAccount: string | number): CLIConfig_NEW | null;
-    /**
-     * @throws {Error}
-     */
-    renameAccount(currentName: string, newName: string): void;
-    /**
-     * @throws {Error}
-     * TODO: this does not account for the special handling of sandbox account deletes
-     */
-    removeAccountFromConfig(nameOrId: string | number): boolean;
-    /**
-     * @throws {Error}
-     */
-    updateDefaultCmsPublishMode(defaultCmsPublishMode: CmsPublishMode): CLIConfig_NEW | null;
-    /**
-     * @throws {Error}
-     */
-    updateHttpTimeout(timeout: string): CLIConfig_NEW | null;
-    /**
-     * @throws {Error}
-     */
-    updateAllowAutoUpdates(enabled: boolean): CLIConfig_NEW | null;
-    /**
-     * @throws {Error}
-     */
-    updateAllowUsageTracking(isEnabled: boolean): CLIConfig_NEW | null;
-    updateAutoOpenBrowser(isEnabled: boolean): CLIConfig_NEW | null;
-    isTrackingAllowed(): boolean;
-    handleLegacyCmsPublishMode(config: CLIConfig_NEW | null): CLIConfig_NEW | null;
-    hasLocalStateFlag(flag: string): boolean;
-    addLocalStateFlag(flag: string): void;
-    removeLocalStateFlag(flag: string): void;
-}
-export declare const CLIConfiguration: _CLIConfiguration;
-export {};