@hubspot/local-dev-lib 0.1.0 → 0.1.1-experimental.0

package/types/Accounts.d.ts

@@ -1,14 +1,19 @@
-import { Mode } from './Files';
+import { HUBSPOT_ACCOUNT_TYPES } from '../constants/config';
+import { CmsPublishMode } from './Files';
 import { Environment } from './Config';
+import { ValueOf } from './Utils';
 export type AuthType = 'personalaccesskey' | 'apikey' | 'oauth2';
 export interface CLIAccount_NEW {
     name?: string;
     accountId: number;
-    defaultMode?: Mode;
+    accountType?: AccountType;
+    defaultCmsPublishMode?: CmsPublishMode;
     env: Environment;
     authType?: AuthType;
     auth?: {
         tokenInfo?: TokenInfo;
+        clientId?: string;
+        clientSecret?: string;
     };
     sandboxAccountType?: string | null;
     parentAccountId?: number | null;
@@ -18,11 +23,14 @@ export interface CLIAccount_NEW {
 export interface CLIAccount_DEPRECATED {
     name?: string;
     portalId?: number;
-    defaultMode?: Mode;
+    defaultCmsPublishMode?: CmsPublishMode;
     env: Environment;
+    accountType?: AccountType;
     authType?: AuthType;
     auth?: {
         tokenInfo?: TokenInfo;
+        clientId?: string;
+        clientSecret?: string;
     };
     sandboxAccountType?: string | null;
     parentAccountId?: number | null;
@@ -30,6 +38,11 @@ export interface CLIAccount_DEPRECATED {
     personalAccessKey?: string;
 }
 export type CLIAccount = CLIAccount_NEW | CLIAccount_DEPRECATED;
+export type GenericAccount = {
+    portalId?: number;
+    accountId?: number;
+};
+export type AccountType = ValueOf<typeof HUBSPOT_ACCOUNT_TYPES>;
 export type TokenInfo = {
     accessToken?: string;
     expiresAt?: string;
@@ -93,3 +106,77 @@ export type ScopeData = {
     portalScopesInGroup: Array<string>;
     userScopesInGroup: Array<string>;
 };
+export type AccessTokenResponse = {
+    hubId: number;
+    userId: number;
+    oauthAccessToken: string;
+    expiresAtMillis: number;
+    enabledFeatures?: {
+        [key: string]: number;
+    };
+    scopeGroups: Array<string>;
+    encodedOAuthRefreshToken: string;
+    hubName: string;
+    accountType: ValueOf<typeof HUBSPOT_ACCOUNT_TYPES>;
+};
+export type EnabledFeaturesResponse = {
+    enabledFeatures: {
+        [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;
+    expiresAt: string;
+    scopeGroups: Array<string>;
+    enabledFeatures?: {
+        [key: string]: number;
+    };
+    encodedOAuthRefreshToken: string;
+    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;
+    access_token: string;
+    expires_in: string;
+};
+export type ExchangeProof = {
+    grant_type: string;
+    client_id?: string;
+    client_secret?: string;
+    refresh_token?: string;
+};

package/types/Apps.d.ts

@@ -0,0 +1,77 @@
+export type PublicAppInstallationData = {
+    appId: number;
+    isInstalledWithScopeGroups: boolean;
+    previouslyAuthorizedScopeGroups: Array<{
+        id: number;
+        name: string;
+    }>;
+};
+export type PublicAppDeveloperTestAccountInstallData = {
+    testPortalInstalls: Array<{
+        portalId: number;
+        accountName: string;
+    }>;
+    testPortalInstallCount: string;
+};
+export type PublicAppInstallCounts = {
+    uniquePortalInstallCount: number;
+    uniqueUserInstallCount: number;
+    uniqueBusinessUnitInstallCount: number;
+};
+export type PublicApp = {
+    id: number;
+    name: string;
+    description: string;
+    portalId: number;
+    updatedAt: number;
+    createdAt: number;
+    clientId: string;
+    iconUrl: string;
+    archived: boolean;
+    ownerId: number;
+    isUserLevel: boolean;
+    isBusinessUnitEnabled: boolean;
+    isFeatured: boolean;
+    isInternal: boolean;
+    documentationUrl: string | null;
+    supportUrl: string | null;
+    supportEmail: string | null;
+    supportPhone: string | null;
+    extensionIconUrl: string | null;
+    isAdvancedScopesSettingEnabled: boolean;
+    publicApplicationInstallCounts: PublicAppInstallCounts;
+    redirectUrls: Array<string>;
+    scopeGroupIds: Array<number>;
+    requiredScopeInfo?: Array<{
+        id: number;
+        name: string;
+    }>;
+    additionalScopeGroupIds: Array<number>;
+    additionalScopeInfo?: Array<{
+        id: number;
+        name: string;
+    }>;
+    optionalScopeGroupIds: Array<number>;
+    optionalScopeInfo?: Array<{
+        id: number;
+        name: string;
+    }>;
+    projectId: number | null;
+    sourceId: string | null;
+    providerInfo?: {
+        domain: string;
+        isVerified: boolean;
+    };
+    listingInfo?: {
+        listingUrl: string;
+        isCertified: boolean;
+        isPublished: boolean;
+        hasDraft: boolean;
+        inReview: boolean;
+    };
+    allowedExternalUrls: Array<string>;
+    preventProjectMigrations?: boolean;
+};
+export type FetchPublicAppsForPortalResponse = {
+    results: Array<PublicApp>;
+};

package/types/Archive.d.ts

@@ -0,0 +1,9 @@
+export type ZipData = {
+    extractDir: string;
+    tmpDir: string;
+};
+export type CopySourceToDestOptions = {
+    sourceDir?: string;
+    includesRootDir?: boolean;
+    hideLogs?: boolean;
+};

package/types/Archive.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/types/Build.d.ts

@@ -2,17 +2,18 @@ import { ValueOf } from './Utils';
 import { BUILD_STATUS, SUBBUILD_TYPES, DEPLOYABLE_STATES } from '../enums/build';
 import { ActivitySource } from './Activity';
 import { DeployStatusTaskLocator } from './Deploy';
-import { OptionalError } from './Error';
+import { ProjectStandardError } from './Project';
 export type SubbuildStatus = {
     buildName: string;
     buildType: ValueOf<typeof SUBBUILD_TYPES>;
     errorMessage: string;
     finishedAt: string;
     rootPath: string;
-    standardError?: OptionalError;
+    standardError: ProjectStandardError | null;
     startedAt: string;
     status: ValueOf<typeof BUILD_STATUS>;
     id: string;
+    visible: boolean;
 };
 export type Build = {
     activitySource: ActivitySource;
@@ -29,6 +30,7 @@ export type Build = {
     status: ValueOf<typeof BUILD_STATUS>;
     subbuildStatuses: Array<SubbuildStatus>;
     uploadMessage: string;
+    autoDeployId: number;
 };
 export type FetchProjectBuildsResponse = {
     results: Array<Build>;

package/types/ComponentStructure.d.ts

@@ -6,15 +6,35 @@ export type ComponentStructure = {
 export type ComponentStructureResponse = {
     topLevelComponentsWithChildren: ComponentStructure;
 };
-export type ComponentMetadata = {
-    componentIdentifier: string;
+export type ProjectComponentsMetadata = {
+    topLevelComponentMetadata: TopLevelComponents[];
+};
+export interface ComponentMetadata<T> {
     componentName: string;
-    componentType: ValueOf<typeof COMPONENT_TYPES> | ValueOf<typeof SUBCOMPONENT_TYPES>;
-    metadata: {
-        appId: string;
+    type: {
+        name: T;
     };
-    parentComponentType: string;
-};
-export type ComponentMetadataResponse = {
-    results: Array<ComponentMetadata>;
-};
+    deployOutput: unknown;
+}
+export interface TopLevelComponent extends ComponentMetadata<ValueOf<typeof COMPONENT_TYPES>> {
+    featureComponents: FeatureComponents[];
+}
+export interface PrivateAppComponentMetadata extends TopLevelComponent {
+    deployOutput: {
+        cardId: number;
+        appId: number;
+    };
+}
+export type TopLevelComponents = PrivateAppComponentMetadata | TopLevelComponent;
+export interface FeatureComponent<T = unknown> extends ComponentMetadata<ValueOf<typeof SUBCOMPONENT_TYPES>> {
+    deployOutput: T;
+}
+export type AppFunctionComponentMetadata = FeatureComponent<{
+    appId: number;
+    appFunctionName: string;
+    endpoint?: {
+        path: string;
+        methods: string[];
+    };
+}>;
+export type FeatureComponents = FeatureComponent | AppFunctionComponentMetadata;

package/types/Config.d.ts

@@ -1,11 +1,13 @@
 import { ENVIRONMENTS } from '../constants/environments';
 import { CLIAccount_NEW, CLIAccount_DEPRECATED } from './Accounts';
+import { CmsPublishMode } from './Files';
 import { ValueOf } from './Utils';
 export interface CLIConfig_NEW {
     accounts: Array<CLIAccount_NEW>;
     allowUsageTracking?: boolean;
     defaultAccount?: string | number;
-    defaultMode?: string;
+    defaultMode?: CmsPublishMode;
+    defaultCmsPublishMode?: CmsPublishMode;
     httpTimeout?: number;
     env?: Environment;
     httpUseLocalhost?: boolean;
@@ -14,10 +16,25 @@ export interface CLIConfig_DEPRECATED {
     portals: Array<CLIAccount_DEPRECATED>;
     allowUsageTracking?: boolean;
     defaultPortal?: string | number;
-    defaultMode?: string;
+    defaultMode?: CmsPublishMode;
+    defaultCmsPublishMode?: CmsPublishMode;
     httpTimeout?: number;
     env?: Environment;
     httpUseLocalhost?: boolean;
 }
 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 GitInclusionResult = {
+    inGit: boolean;
+    configIgnored: boolean;
+    gitignoreFiles: Array<string>;
+};

package/types/Deploy.d.ts

@@ -2,7 +2,7 @@ import { ValueOf } from './Utils';
 import { ACTIVITY_SOURCE } from '../enums/project';
 import { DEPLOY_ACTION, DEPLOY_STATUS } from '../enums/deploy';
 import { COMPONENT_TYPES, SUBCOMPONENT_TYPES } from '../enums/build';
-import { OptionalError } from './Error';
+import { ProjectStandardError } from './Project';
 export type DeployStatus = ValueOf<typeof DEPLOY_STATUS>;
 export type SubdeployStatus = {
     action: ValueOf<typeof DEPLOY_ACTION>;
@@ -10,10 +10,11 @@ export type SubdeployStatus = {
     deployType: ValueOf<typeof COMPONENT_TYPES> | ValueOf<typeof SUBCOMPONENT_TYPES>;
     errorMessage: string;
     finishedAt: string;
-    standardError?: OptionalError;
+    standardError: ProjectStandardError | null;
     startedAt: string;
     status: DeployStatus;
     id: string;
+    visible: boolean;
 };
 export type Deploy = {
     buildId: number;

package/types/DesignManager.d.ts

@@ -0,0 +1,10 @@
+export type FetchThemesResponse = {
+    objects: Array<{
+        theme: {
+            path: string;
+        };
+    }>;
+};
+export type FetchBuiltinMappingResponse = {
+    [key: string]: string;
+};

package/types/DesignManager.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/types/Error.d.ts

@@ -16,17 +16,22 @@ export interface ValidationError extends BaseError {
     errorTokens?: {
         line: number;
     };
+    context?: {
+        requiredScopes?: string[];
+    };
 }
 export type FileSystemErrorContext = {
-    filepath: string;
-    write?: boolean;
-    read?: boolean;
+    filepath?: string;
+    operation?: 'write' | 'read';
     accountId?: number;
+    dest?: string;
 };
-export type AxiosErrorContext = {
-    accountId?: number;
+export interface HubSpotHttpErrorContext extends FileSystemErrorContext {
     request?: string;
     payload?: string;
     projectName?: string;
-};
+}
 export type OptionalError = BaseError | null | undefined;
+export type ErrorContext = {
+    accountId?: number;
+};

package/types/FieldsJS.d.ts

@@ -0,0 +1 @@
+export type FieldsArray<T> = Array<T | FieldsArray<T>>;

package/types/FieldsJS.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/types/FileManager.d.ts

@@ -1,4 +1,4 @@
-type File = {
+export type File = {
     id: number;
     portal_id: number;
     name: string;
@@ -13,7 +13,6 @@ type File = {
     friendly_url: string;
     meta: {
         allows_anonymous_access: boolean;
-        charset_guess: string;
         line_count: number;
         indexable: boolean;
     };
@@ -35,8 +34,8 @@ type File = {
     cdn_purge_embargo_time: number | null;
     file_hash: string;
 };
-type Folder = {
-    id: number;
+export type Folder = {
+    id: number | 'None';
     portal_id: number;
     name: string;
     deleted: boolean;
@@ -57,10 +56,16 @@ export type FetchStatResponse = {
     file: File | null;
     folder: Folder | null;
 };
-export type FetchFilesOrFolderResponse = {
+export type FetchFilesResponse = {
+    limit: number;
+    offset: number;
+    objects: Array<File>;
+    total_count: number;
+};
+export type FetchFolderResponse = {
     limit: number;
     offset: number;
-    objects: Array<File | Folder>;
+    objects: Array<Folder>;
     total_count: number;
 };
-export {};
+export type SimplifiedFolder = Partial<Folder> & Pick<Folder, 'id' | 'name'>;

package/types/Files.d.ts

@@ -1,8 +1,8 @@
-import { AxiosError } from 'axios';
 import { ValueOf } from '../types/Utils';
 import { STAT_TYPES, FILE_TYPES, FILE_UPLOAD_RESULT_TYPES } from '../constants/files';
-import { MODE } from '../constants/files';
+import { CMS_PUBLISH_MODE } from '../constants/files';
 import { HttpOptions } from './Http';
+import { AxiosError } from 'axios';
 export type StatType = ValueOf<typeof STAT_TYPES>;
 export type FileData = {
     filepath: string;
@@ -18,7 +18,7 @@ export type FileMapperNode = {
     folder: boolean;
     children: Array<FileMapperNode>;
 };
-export type Mode = ValueOf<typeof MODE>;
+export type CmsPublishMode = ValueOf<typeof CMS_PUBLISH_MODE>;
 export type FileMapperOptions = Omit<HttpOptions, 'url'>;
 export type FileMapperInputOptions = {
     staging?: boolean;
@@ -29,7 +29,7 @@ export type FileType = ValueOf<typeof FILE_TYPES>;
 type ResultType = ValueOf<typeof FILE_UPLOAD_RESULT_TYPES>;
 export type UploadFolderResults = {
     resultType: ResultType;
-    error: AxiosError | null;
+    error: unknown;
     file: string;
 };
 export type FileTree = {
@@ -37,4 +37,43 @@ export type FileTree = {
     path: string;
     children: Array<FileTree>;
 };
+export type PathTypeData = {
+    isModule: boolean;
+    isHubspot: boolean;
+    isFile: boolean;
+    isRoot: boolean;
+    isFolder: boolean;
+};
+export type RecursiveFileMapperCallback = (node: FileMapperNode, filepath?: string, depth?: number) => boolean;
+export type CommandOptions = {
+    convertFields?: boolean;
+    fieldOptions?: string;
+    saveOutput?: boolean;
+    onAttemptCallback?: (file: string | undefined, destPath: string) => void;
+    onSuccessCallback?: (file: string | undefined, destPath: string) => void;
+    onFirstErrorCallback?: (file: string, destPath: string, error: unknown) => void;
+    onRetryCallback?: (file: string, destPath: string) => void;
+    onFinalErrorCallback?: (accountId: number, file: string, destPath: string, error: unknown) => void;
+};
+export type FilePathsByType = {
+    [key: string]: Array<string>;
+};
+export type UploadFileOptions = FileMapperInputOptions & {
+    src: string;
+    commandOptions: {
+        convertFields?: boolean;
+    };
+    fieldOptions?: string;
+};
+export type WatchOptions = {
+    cmsPublishMode?: CmsPublishMode;
+    remove?: boolean;
+    disableInitial?: boolean;
+    notify?: string;
+    commandOptions: {
+        convertFields?: boolean;
+    };
+    filePaths?: Array<string>;
+};
+export type WatchErrorHandler = (error: AxiosError) => void;
 export {};

package/types/Functions.d.ts

@@ -37,4 +37,56 @@ export type GetBuildStatusResponse = {
     userId: number;
     deployId: number;
 };
+export type FunctionConfig = {
+    runtime: string;
+    version: string;
+    environment: object;
+    secrets: Array<string>;
+    endpoints: {
+        [key: string]: {
+            method: string;
+            file: string;
+        };
+    };
+};
+export type FunctionConfigInfo = {
+    endpointPath: string;
+    endpointMethod: string;
+    functionFile: string;
+};
+export type FunctionInfo = {
+    functionsFolder: string;
+    filename: string;
+    endpointPath: string;
+    endpointMethod: string;
+};
+export type FunctionOptions = {
+    allowExistingFile?: boolean;
+};
+export type FunctionLog = {
+    id: string;
+    executionTime: number;
+    log: string;
+    error: {
+        message: string;
+        type: string;
+        stackTrace: string[][];
+    };
+    status: string;
+    createdAt: number;
+    memory: string;
+};
+export type GetFunctionLogsResponse = {
+    results: FunctionLog[];
+    paging: {
+        next: {
+            after: string;
+            link: string;
+        };
+        prev: {
+            before: string;
+            link: string;
+        };
+    };
+};
 export {};

package/types/Github.d.ts

@@ -61,4 +61,16 @@ export interface GithubSourceData {
     repositoryName: string;
     source: string;
 }
+export type RepoPath = `${string}/${string}`;
+export type DownloadGithubRepoZipOptions = {
+    branch?: string;
+    tag?: string;
+};
+export type CloneGithubRepoOptions = {
+    isRelease?: boolean;
+    type?: string;
+    branch?: string;
+    tag?: string;
+    sourceDir?: string;
+};
 export {};

package/types/Http.d.ts

@@ -1,29 +1,29 @@
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { AxiosPromise, ResponseType } from 'axios';
 import { ReadStream } from 'fs';
+import { Stream } from 'stream';
+export type HubSpotPromise<T = unknown> = AxiosPromise<T>;
 export type Data = {
     [key: string]: any;
 };
 export type QueryParams = {
     [key: string]: string | number | boolean | undefined;
 };
-export type AxiosConfigOptions = {
+export type FormData = {
+    [key: string]: string | ReadStream;
+};
+export type HttpOptions = {
     baseURL?: string;
     url: string;
     env?: string;
     localHostOverride?: boolean;
-    params?: QueryParams;
-    data?: Data;
+    data?: Data | string | ArrayBuffer | ArrayBufferView | URLSearchParams | Stream | Buffer;
     resolveWithFullResponse?: boolean;
+    params?: QueryParams;
     timeout?: number;
-};
-export type FormData = {
-    [key: string]: string | ReadStream;
-};
-export type HttpOptions = AxiosConfigOptions & {
-    query?: QueryParams;
-    formData?: FormData;
-    timeout?: number;
-    encoding?: string | null;
+    responseType?: ResponseType;
     headers?: {
         [header: string]: string | string[] | undefined;
     };

package/types/Hubdb.d.ts

@@ -98,3 +98,12 @@ export type FetchRowsResponse = {
         };
     } | null;
 };
+export type FetchTablesResponse = {
+    total: number;
+    results: Array<Table>;
+    paging?: {
+        next: {
+            after: string | null;
+        };
+    } | null;
+};

package/types/Lang.d.ts

@@ -5,3 +5,6 @@ export type GenericLanguageObject = {
 };
 export type LanguageObject = typeof lang;
 export type LangKey = Leaves<LanguageObject>;
+export type InterpolationData = {
+    [identifier: string]: string | number;
+};