@hubspot/local-dev-lib 1.9.0 → 1.10.0

package/api/appsDev.d.ts

@@ -1,4 +1,5 @@
-import { PublicApp, PublicAppDeveloperTestAccountInstallData } from '../types/Apps';
+import { PublicApp, PublicAppInstallCounts, PublicAppDeveloperTestAccountInstallData } from '../types/Apps';
 export declare function fetchPublicAppsForPortal(accountId: number): Promise<Array<PublicApp>>;
 export declare function fetchPublicAppDeveloperTestAccountInstallData(appId: number, accountId: number): Promise<PublicAppDeveloperTestAccountInstallData>;
+export declare function fetchPublicAppProductionInstallCounts(appId: number, accountId: number): Promise<PublicAppInstallCounts>;
 export declare function fetchPublicAppMetadata(appId: number, accountId: number): Promise<PublicApp>;

package/api/appsDev.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchPublicAppMetadata = exports.fetchPublicAppDeveloperTestAccountInstallData = exports.fetchPublicAppsForPortal = void 0;
+exports.fetchPublicAppMetadata = exports.fetchPublicAppProductionInstallCounts = exports.fetchPublicAppDeveloperTestAccountInstallData = exports.fetchPublicAppsForPortal = void 0;
 const http_1 = __importDefault(require("../http"));
 const APPS_DEV_API_PATH = 'apps-dev/external/public/v3';
 async function fetchPublicAppsForPortal(accountId) {
@@ -19,6 +19,12 @@ function fetchPublicAppDeveloperTestAccountInstallData(appId, accountId) {
     });
 }
 exports.fetchPublicAppDeveloperTestAccountInstallData = fetchPublicAppDeveloperTestAccountInstallData;
+function fetchPublicAppProductionInstallCounts(appId, accountId) {
+    return http_1.default.get(accountId, {
+        url: `${APPS_DEV_API_PATH}/${appId}/install-counts-without-test-portals`,
+    });
+}
+exports.fetchPublicAppProductionInstallCounts = fetchPublicAppProductionInstallCounts;
 function fetchPublicAppMetadata(appId, accountId) {
     return http_1.default.get(accountId, {
         url: `${APPS_DEV_API_PATH}/${appId}/full`,

package/api/customObjects.d.ts

@@ -1,20 +1,7 @@
-import { FetchSchemasResponse, Schema } from '../types/Schemas';
-type CreateObjectsResponse = {
-    status: string;
-    startedAt: string;
-    completedAt: string;
-    results: Array<{
-        id: string;
-        properties: Array<any>;
-        createdAt: string;
-        updatedAt: string;
-        archived: boolean;
-    }>;
-};
+import { FetchSchemasResponse, Schema, CreateObjectsResponse } from '../types/Schemas';
 export declare function batchCreateObjects(accountId: number, objectTypeId: string, objects: JSON): Promise<CreateObjectsResponse>;
 export declare function createObjectSchema(accountId: number, schema: JSON): Promise<Schema>;
 export declare function updateObjectSchema(accountId: number, schemaObjectType: string, schema: Schema): Promise<Schema>;
 export declare function fetchObjectSchema(accountId: number, schemaObjectType: string): Promise<Schema>;
 export declare function fetchObjectSchemas(accountId: number): Promise<FetchSchemasResponse>;
 export declare function deleteObjectSchema(accountId: number, schemaObjectType: string): Promise<void>;
-export {};

package/api/designManager.d.ts

@@ -1,14 +1,4 @@
 import { QueryParams } from '../types/Http';
-type FetchThemesResponse = {
-    objects: Array<{
-        theme: {
-            path: string;
-        };
-    }>;
-};
+import { FetchThemesResponse, FetchBuiltinMappingResponse } from '../types/DesignManager';
 export declare function fetchThemes(accountId: number, params?: QueryParams): Promise<FetchThemesResponse>;
-type FetchBuiltinMappingResponse = {
-    [key: string]: string;
-};
 export declare function fetchBuiltinMapping(accountId: number): Promise<FetchBuiltinMappingResponse>;
-export {};

package/api/github.d.ts

@@ -1,13 +1,11 @@
 /// <reference types="node" />
 import { AxiosResponse } from 'axios';
-import { GithubReleaseData, GithubRepoFile } from '../types/Github';
+import { GithubReleaseData, GithubRepoFile, RepoPath } from '../types/Github';
 declare global {
     var githubToken: string;
 }
-type RepoPath = `${string}/${string}`;
 export declare function fetchRepoReleaseData(repoPath: RepoPath, tag?: string): Promise<AxiosResponse<GithubReleaseData>>;
 export declare function fetchRepoAsZip(zipUrl: string): Promise<AxiosResponse<Buffer>>;
 export declare function fetchRepoFile(repoPath: RepoPath, filePath: string, ref: string): Promise<AxiosResponse<Buffer>>;
 export declare function fetchRepoFileByDownloadUrl(downloadUrl: string): Promise<AxiosResponse<Buffer>>;
 export declare function fetchRepoContents(repoPath: RepoPath, path: string, ref?: string): Promise<AxiosResponse<Array<GithubRepoFile>>>;
-export {};

package/api/localDevAuth.d.ts

@@ -1,22 +1,6 @@
 import { Environment } from '../types/Config';
-import { ScopeData } from '../types/Accounts';
-import { HUBSPOT_ACCOUNT_TYPES } from '../constants/config';
-import { ValueOf } from '../types/Utils';
+import { ScopeData, AccessTokenResponse } from '../types/Accounts';
 import { PublicAppInstallationData } from '../types/Apps';
-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 declare function fetchAccessToken(personalAccessKey: string, env?: Environment, portalId?: number): Promise<AccessTokenResponse>;
 export declare function fetchScopeData(accountId: number, scopeGroup: string): Promise<ScopeData>;
 export declare function fetchAppInstallationData(portalId: number, projectId: number, appUid: string, requiredScopeGroups: Array<string>, optionalScopeGroups?: Array<string>): Promise<PublicAppInstallationData>;
-export {};

package/api/projects.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { QueryParams } from '../types/Http';
-import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings } from '../types/Project';
+import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse } from '../types/Project';
 import { Build, FetchProjectBuildsResponse } from '../types/Build';
 import { ComponentMetadataResponse, ComponentStructureResponse } from '../types/ComponentStructure';
 import { Deploy, ProjectDeployResponse } from '../types/Deploy';
@@ -12,10 +12,6 @@ export declare function uploadProject(accountId: number, projectName: string, pr
 export declare function fetchProject(accountId: number, projectName: string): Promise<Project>;
 export declare function downloadProject(accountId: number, projectName: string, buildId: number): Promise<Buffer>;
 export declare function deleteProject(accountId: number, projectName: string): Promise<void>;
-type FetchPlatformVersionResponse = {
-    defaultPlatformVersion: string;
-    activePlatformVersions: Array<string>;
-};
 export declare function fetchPlatformVersions(accountId: number): Promise<FetchPlatformVersionResponse>;
 export declare function fetchProjectBuilds(accountId: number, projectName: string, params?: QueryParams): Promise<FetchProjectBuildsResponse>;
 export declare function getBuildStatus(accountId: number, projectName: string, buildId: number): Promise<Build>;
@@ -41,4 +37,3 @@ export declare function checkMigrationStatus(accountId: number, id: number): Pro
 export declare function cloneApp(accountId: number, appId: number): Promise<CloneAppResponse>;
 export declare function checkCloneStatus(accountId: number, exportId: number): Promise<CloneAppResponse>;
 export declare function downloadClonedProject(accountId: number, exportId: number): Promise<Buffer>;
-export {};

package/api/projects.js

@@ -13,13 +13,13 @@ const DEVELOPER_PROJECTS_API_PATH = 'developer/projects/v1';
 const MIGRATIONS_API_PATH = 'dfs/migrations/v1';
 async function fetchProjects(accountId) {
     return http_1.default.get(accountId, {
-        url: PROJECTS_API_PATH,
+        url: DEVELOPER_PROJECTS_API_PATH,
     });
 }
 exports.fetchProjects = fetchProjects;
 async function createProject(accountId, name) {
     return http_1.default.post(accountId, {
-        url: PROJECTS_API_PATH,
+        url: DEVELOPER_PROJECTS_API_PATH,
         data: {
             name,
         },
@@ -44,7 +44,7 @@ async function uploadProject(accountId, projectName, projectFile, uploadMessage,
 exports.uploadProject = uploadProject;
 async function fetchProject(accountId, projectName) {
     return http_1.default.get(accountId, {
-        url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}`,
+        url: `${DEVELOPER_PROJECTS_API_PATH}/by-name/${encodeURIComponent(projectName)}`,
     });
 }
 exports.fetchProject = fetchProject;
@@ -58,7 +58,7 @@ async function downloadProject(accountId, projectName, buildId) {
 exports.downloadProject = downloadProject;
 async function deleteProject(accountId, projectName) {
     return http_1.default.delete(accountId, {
-        url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}`,
+        url: `${DEVELOPER_PROJECTS_API_PATH}/${encodeURIComponent(projectName)}`,
     });
 }
 exports.deleteProject = deleteProject;
@@ -111,7 +111,7 @@ async function getDeployStructure(accountId, projectName, deployId) {
 exports.getDeployStructure = getDeployStructure;
 async function fetchProjectSettings(accountId, projectName) {
     return http_1.default.get(accountId, {
-        url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/settings`,
+        url: `${DEVELOPER_PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/settings`,
     });
 }
 exports.fetchProjectSettings = fetchProjectSettings;

package/api/secrets.d.ts

@@ -1,8 +1,5 @@
-type FetchSecretsResponse = {
-    results: Array<string>;
-};
+import { FetchSecretsResponse } from '../types/Secrets';
 export declare function addSecret(accountId: number, key: string, value: string): Promise<void>;
 export declare function updateSecret(accountId: number, key: string, value: string): Promise<void>;
 export declare function deleteSecret(accountId: number, key: string): Promise<void>;
 export declare function fetchSecrets(accountId: number): Promise<FetchSecretsResponse>;
-export {};

package/config/configUtils.d.ts

@@ -1,24 +1,5 @@
-import { CLIConfig_NEW, Environment } from '../types/Config';
-import { AuthType, CLIAccount_NEW } from '../types/Accounts';
+import { CLIConfig_NEW } from '../types/Config';
+import { AuthType, CLIAccount_NEW, PersonalAccessKeyOptions, OAuthOptions, APIKeyOptions } from '../types/Accounts';
 export declare function getOrderedAccount(unorderedAccount: CLIAccount_NEW): CLIAccount_NEW;
 export declare function getOrderedConfig(unorderedConfig: CLIConfig_NEW): CLIConfig_NEW;
-type PersonalAccessKeyOptions = {
-    accountId: number;
-    personalAccessKey: string;
-    env: Environment;
-};
-type OAuthOptions = {
-    accountId: number;
-    clientId: string;
-    clientSecret: string;
-    refreshToken: string;
-    scopes: Array<string>;
-    env: Environment;
-};
-type APIKeyOptions = {
-    accountId: number;
-    apiKey: string;
-    env: Environment;
-};
 export declare function generateConfig(type: AuthType, options: PersonalAccessKeyOptions | OAuthOptions | APIKeyOptions): CLIConfig_NEW | null;
-export {};

package/config/config_DEPRECATED.d.ts

@@ -1,5 +1,5 @@
 import { CLIConfig_DEPRECATED, Environment } from '../types/Config';
-import { AccountType, CLIAccount_DEPRECATED, FlatAccountFields_DEPRECATED } from '../types/Accounts';
+import { AccountType, CLIAccount_DEPRECATED, FlatAccountFields_DEPRECATED, UpdateAccountConfigOptions } from '../types/Accounts';
 import { Mode } from '../types/Files';
 import { CLIOptions, WriteConfigOptions } from '../types/CLIOptions';
 export declare const getConfig: () => CLIConfig_DEPRECATED | null;
@@ -34,9 +34,6 @@ export declare function getAccountId(nameOrId?: string | number): number | undef
  * @throws {Error}
  */
 export declare function removeSandboxAccountFromConfig(nameOrId: string | number): boolean;
-type UpdateAccountConfigOptions = Partial<FlatAccountFields_DEPRECATED> & {
-    environment?: Environment;
-};
 /**
  * @throws {Error}
  */
@@ -76,4 +73,3 @@ export declare function loadConfigFromEnvironment({ useEnv, }?: {
     portals: Array<CLIAccount_DEPRECATED>;
 } | undefined;
 export declare function isConfigFlagEnabled(flag: keyof CLIConfig_DEPRECATED): boolean;
-export {};

package/constants/extensions.d.ts

@@ -1,4 +1,5 @@
 export declare const ALLOWED_EXTENSIONS: Set<string>;
+export declare const JSR_ALLOWED_EXTENSIONS: Set<string>;
 export declare const HUBL_EXTENSIONS: Set<string>;
 export declare const MODULE_EXTENSION = "module";
 export declare const FUNCTIONS_EXTENSION = "functions";

package/constants/extensions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FOLDER_DOT_EXTENSIONS = exports.FUNCTIONS_EXTENSION = exports.MODULE_EXTENSION = exports.HUBL_EXTENSIONS = exports.ALLOWED_EXTENSIONS = void 0;
+exports.FOLDER_DOT_EXTENSIONS = exports.FUNCTIONS_EXTENSION = exports.MODULE_EXTENSION = exports.HUBL_EXTENSIONS = exports.JSR_ALLOWED_EXTENSIONS = exports.ALLOWED_EXTENSIONS = void 0;
 exports.ALLOWED_EXTENSIONS = new Set([
     'css',
     'js',
@@ -21,6 +21,7 @@ exports.ALLOWED_EXTENSIONS = new Set([
     'woff2',
     'graphql',
 ]);
+exports.JSR_ALLOWED_EXTENSIONS = new Set(['jsx', 'tsx', 'ts']);
 exports.HUBL_EXTENSIONS = new Set(['css', 'html', 'js']);
 exports.MODULE_EXTENSION = 'module';
 exports.FUNCTIONS_EXTENSION = 'functions';

package/errors/errors_DEPRECATED.d.ts

@@ -1,7 +1,3 @@
-import { BaseError, FileSystemErrorContext } from '../types/Error';
-type ErrorContext = {
-    accountId?: number;
-};
+import { BaseError, FileSystemErrorContext, ErrorContext } from '../types/Error';
 export declare function logErrorInstance(error: BaseError, context?: ErrorContext): void;
 export declare function logFileSystemErrorInstance(error: BaseError, context: FileSystemErrorContext): void;
-export {};

package/http/index.d.ts

@@ -2,10 +2,15 @@ import { AxiosResponse } from 'axios';
 import { HttpOptions } from '../types/Http';
 export declare function addUserAgentHeader(key: string, value: string): void;
 declare function getRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
+declare function getRequest<T>(accountId: number, options: HttpOptions, withFullResponse: true): Promise<AxiosResponse<T>>;
 declare function postRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
+declare function postRequest<T>(accountId: number, options: HttpOptions, withFullResponse: true): Promise<AxiosResponse<T>>;
 declare function putRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
+declare function putRequest<T>(accountId: number, options: HttpOptions, withFullResponse: true): Promise<AxiosResponse<T>>;
 declare function patchRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
+declare function patchRequest<T>(accountId: number, options: HttpOptions, withFullResponse: true): Promise<AxiosResponse<T>>;
 declare function deleteRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
+declare function deleteRequest<T>(accountId: number, options: HttpOptions, withFullResponse: true): Promise<AxiosResponse<T>>;
 declare const http: {
     get: typeof getRequest;
     post: typeof postRequest;

package/http/index.js

@@ -88,32 +88,47 @@ function addQueryParams(configOptions, queryParams = {}) {
         },
     };
 }
-async function getRequest(accountId, options) {
+async function getRequest(accountId, options, withFullResponse) {
     const { params, ...rest } = options;
     const axiosConfig = addQueryParams(rest, params);
     const configWithAuth = await withAuth(accountId, axiosConfig);
-    const { data } = await (0, axios_1.default)(configWithAuth);
-    return data;
+    const response = await (0, axios_1.default)(configWithAuth);
+    if (withFullResponse) {
+        return response;
+    }
+    return response.data;
 }
-async function postRequest(accountId, options) {
+async function postRequest(accountId, options, withFullResponse) {
     const configWithAuth = await withAuth(accountId, options);
-    const { data } = await (0, axios_1.default)({ ...configWithAuth, method: 'post' });
-    return data;
+    const response = await (0, axios_1.default)({ ...configWithAuth, method: 'post' });
+    if (withFullResponse) {
+        return response;
+    }
+    return response.data;
 }
-async function putRequest(accountId, options) {
+async function putRequest(accountId, options, withFullResponse) {
     const configWithAuth = await withAuth(accountId, options);
-    const { data } = await (0, axios_1.default)({ ...configWithAuth, method: 'put' });
-    return data;
+    const response = await (0, axios_1.default)({ ...configWithAuth, method: 'put' });
+    if (withFullResponse) {
+        return response;
+    }
+    return response.data;
 }
-async function patchRequest(accountId, options) {
+async function patchRequest(accountId, options, withFullResponse) {
     const configWithAuth = await withAuth(accountId, options);
-    const { data } = await (0, axios_1.default)({ ...configWithAuth, method: 'patch' });
-    return data;
+    const response = await (0, axios_1.default)({ ...configWithAuth, method: 'patch' });
+    if (withFullResponse) {
+        return response;
+    }
+    return response.data;
 }
-async function deleteRequest(accountId, options) {
+async function deleteRequest(accountId, options, withFullResponse = false) {
     const configWithAuth = await withAuth(accountId, options);
-    const { data } = await (0, axios_1.default)({ ...configWithAuth, method: 'delete' });
-    return data;
+    const response = await (0, axios_1.default)({ ...configWithAuth, method: 'delete' });
+    if (withFullResponse) {
+        return response;
+    }
+    return response.data;
 }
 function createGetRequestStream(contentType) {
     return async (accountId, options, destPath) => {

package/lib/archive.d.ts

@@ -1,8 +1,3 @@
 /// <reference types="node" />
-type CopySourceToDestOptions = {
-    sourceDir?: string;
-    includesRootDir?: boolean;
-    hideLogs?: boolean;
-};
+import { CopySourceToDestOptions } from '../types/Archive';
 export declare function extractZipArchive(zip: Buffer, name: string, dest: string, { sourceDir, includesRootDir, hideLogs }?: CopySourceToDestOptions): Promise<boolean>;
-export {};

package/lib/cms/functions.d.ts

@@ -1,11 +1,2 @@
-type FunctionInfo = {
-    functionsFolder: string;
-    filename: string;
-    endpointPath: string;
-    endpointMethod: string;
-};
-type FunctionOptions = {
-    allowExistingFile?: boolean;
-};
+import { FunctionInfo, FunctionOptions } from '../../types/Functions';
 export declare function createFunction(functionInfo: FunctionInfo, dest: string, options?: FunctionOptions): Promise<void>;
-export {};

package/lib/cms/modules.d.ts

@@ -1,4 +1,4 @@
-import { PathInput } from '../../types/Modules';
+import { PathInput, ValidationResult, ModuleDefinition } from '../../types/Modules';
 export declare const ValidationIds: {
     SRC_REQUIRED: string;
     DEST_REQUIRED: string;
@@ -6,20 +6,9 @@ export declare const ValidationIds: {
     MODULE_TO_MODULE_NESTING: string;
     MODULE_NESTING: string;
 };
-type ValidationResult = {
-    id: string;
-    message: string;
-};
 export declare function validateSrcAndDestPaths(src?: PathInput, dest?: PathInput): Promise<Array<ValidationResult>>;
-type ModuleDefinition = {
-    contentTypes: Array<string>;
-    moduleLabel: string;
-    reactType: boolean;
-    global: boolean;
-};
 export declare function createModule(moduleDefinition: ModuleDefinition, name: string, dest: string, getInternalVersion: boolean, options?: {
     allowExistingDir: boolean;
 }): Promise<void>;
 export declare function retrieveDefaultModule(name: string | undefined, dest: string): Promise<import("../../types/Github").GithubRepoFile[] | undefined>;
 export declare const isModuleHTMLFile: (filePath: string) => boolean;
-export {};

package/lib/cms/uploadFolder.d.ts

@@ -1,22 +1,7 @@
-import { AxiosError } from 'axios';
 import { FieldsJs } from './handleFieldsJS';
 import { FileMapperInputOptions } from '../../types/Files';
-import { UploadFolderResults } from '../../types/Files';
+import { UploadFolderResults, CommandOptions, FilePathsByType } from '../../types/Files';
 import { Mode } from '../../types/Files';
-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: AxiosError) => void;
-    onRetryCallback?: (file: string, destPath: string) => void;
-    onFinalErrorCallback?: (accountId: number, file: string, destPath: string, error: AxiosError) => void;
-};
-type FilePathsByType = {
-    [key: string]: Array<string>;
-};
 export declare function getFilesByType(filePaths: Array<string>, projectDir: string, rootWriteDir: string | null, commandOptions: CommandOptions): Promise<[FilePathsByType, Array<FieldsJs>]>;
 export declare function uploadFolder(accountId: number, src: string, dest: string, fileMapperOptions: FileMapperInputOptions, commandOptions?: CommandOptions, filePaths?: Array<string>, mode?: Mode | null): Promise<Array<UploadFolderResults>>;
 export declare function hasUploadErrors(results: Array<UploadFolderResults>): boolean;
-export {};

package/lib/cms/watch.d.ts

@@ -1,17 +1,4 @@
 import chokidar from 'chokidar';
-import { AxiosError } from 'axios';
-import { Mode } from '../../types/Files';
+import { WatchOptions, WatchErrorHandler } from '../../types/Files';
 import { UploadFolderResults } from '../../types/Files';
-type WatchOptions = {
-    mode?: Mode;
-    remove?: boolean;
-    disableInitial?: boolean;
-    notify?: string;
-    commandOptions: {
-        convertFields?: boolean;
-    };
-    filePaths?: Array<string>;
-};
-type ErrorHandler = (error: AxiosError) => void;
-export declare function watch(accountId: number, src: string, dest: string, { mode, remove, disableInitial, notify, commandOptions, filePaths, }: WatchOptions, postInitialUploadCallback?: ((result: Array<UploadFolderResults>) => void) | null, onUploadFolderError?: ErrorHandler, onQueueAddError?: ErrorHandler, onUploadFileError?: (file: string, dest: string, accountId: number) => ErrorHandler): chokidar.FSWatcher;
-export {};
+export declare function watch(accountId: number, src: string, dest: string, { mode, remove, disableInitial, notify, commandOptions, filePaths, }: WatchOptions, postInitialUploadCallback?: ((result: Array<UploadFolderResults>) => void) | null, onUploadFolderError?: WatchErrorHandler, onQueueAddError?: WatchErrorHandler, onUploadFileError?: (file: string, dest: string, accountId: number) => WatchErrorHandler): chokidar.FSWatcher;

package/lib/fileMapper.d.ts

@@ -1,18 +1,10 @@
-import { FileMapperNode, Mode, FileMapperOptions, FileMapperInputOptions } from '../types/Files';
+import { FileMapperNode, Mode, FileMapperOptions, FileMapperInputOptions, PathTypeData, RecursiveFileMapperCallback } from '../types/Files';
 export declare function isPathToFile(filepath: string): boolean;
 export declare function isPathToModule(filepath: string): boolean;
 export declare function isPathToRoot(filepath: string): boolean;
 export declare function isPathToHubspot(filepath: string): boolean;
 export declare function getFileMapperQueryValues(mode?: Mode | null, { staging, assetVersion }?: FileMapperInputOptions): FileMapperOptions;
-type PathTypeData = {
-    isModule: boolean;
-    isHubspot: boolean;
-    isFile: boolean;
-    isRoot: boolean;
-    isFolder: boolean;
-};
 export declare function getTypeDataFromPath(src: string): PathTypeData;
-type RecursiveFileMapperCallback = (node: FileMapperNode, filepath?: string, depth?: number) => boolean;
 export declare function recurseFolder(node: FileMapperNode, callback: RecursiveFileMapperCallback, filepath?: string, depth?: number): boolean;
 export declare function writeUtimes(accountId: number, filepath: string, node: FileMapperNode): Promise<void>;
 export declare function fetchFolderFromApi(accountId: number, src: string, mode?: Mode, options?: FileMapperInputOptions): Promise<FileMapperNode>;
@@ -24,4 +16,3 @@ export declare function fetchFolderFromApi(accountId: number, src: string, mode?
  * @returns {Promise}
  */
 export declare function downloadFileOrFolder(accountId: number, src: string, dest: string, mode?: Mode, options?: FileMapperInputOptions): Promise<void>;
-export {};

package/lib/fileMapper.js

@@ -150,7 +150,7 @@ async function fetchAndWriteFileStream(accountId, srcPath, filepath, mode, optio
         logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.skippedExisting`, { filepath }));
         return;
     }
-    if (!(0, path_2.isAllowedExtension)(srcPath)) {
+    if (!(0, path_2.isAllowedExtension)(srcPath, Array.from(extensions_1.JSR_ALLOWED_EXTENSIONS))) {
         (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.invalidFileType`, { srcPath });
     }
     let node;
@@ -272,6 +272,10 @@ async function downloadFolder(accountId, src, destPath, mode, options = {}) {
                 const succeeded = await writeFileMapperNode(accountId, filepath || '', childNode, mode, options);
                 if (succeeded === false) {
                     success = false;
+                    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.errors.failedToFetchFile`, {
+                        src: childNode.path,
+                        dest: filepath || '',
+                    }));
                 }
             });
             return success;

package/lib/github.d.ts

@@ -1,17 +1,8 @@
 /// <reference types="node" />
-import { GithubReleaseData, GithubRepoFile } from '../types/Github';
-type RepoPath = `${string}/${string}`;
+import { GithubReleaseData, GithubRepoFile, RepoPath, CloneGithubRepoOptions } from '../types/Github';
 export declare function fetchFileFromRepository(repoPath: RepoPath, filePath: string, ref: string): Promise<Buffer>;
 export declare function fetchReleaseData(repoPath: RepoPath, tag?: string): Promise<GithubReleaseData>;
-type CloneGithubRepoOptions = {
-    isRelease?: boolean;
-    type?: string;
-    branch?: string;
-    tag?: string;
-    sourceDir?: string;
-};
 export declare function cloneGithubRepo(repoPath: RepoPath, dest: string, options?: CloneGithubRepoOptions): Promise<boolean>;
 export declare function fetchGitHubRepoContentFromDownloadUrl(dest: string, downloadUrl: string): Promise<void>;
 export declare function downloadGithubRepoContents(repoPath: RepoPath, contentPath: string, dest: string, ref?: string, filter?: (contentPiecePath: string, downloadPath: string) => boolean): Promise<void>;
 export declare function listGithubRepoContents(repoPath: RepoPath, contentPath: string, fileFilter?: 'file' | 'dir'): Promise<GithubRepoFile[]>;
-export {};

package/lib/gitignore.d.ts

@@ -1,8 +1,3 @@
+import { GitInclusionResult } from '../types/Config';
 export declare function checkAndAddConfigToGitignore(configPath: string): void;
-type GitInclusionResult = {
-    inGit: boolean;
-    configIgnored: boolean;
-    gitignoreFiles: Array<string>;
-};
 export declare function checkGitInclusion(configPath: string): GitInclusionResult;
-export {};

package/lib/personalAccessKey.d.ts

@@ -1,23 +1,10 @@
 import { CLIAccount } from '../types/Accounts';
 import { Environment } from '../types/Config';
-import { HUBSPOT_ACCOUNT_TYPES } from '../constants/config';
-import { ValueOf } from '../types/Utils';
-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>;
-};
+import { AccessToken } from '../types/Accounts';
 export declare function getAccessToken(personalAccessKey: string, env?: Environment, accountId?: number): Promise<AccessToken>;
 export declare function accessTokenForPersonalAccessKey(accountId: number): Promise<string | undefined>;
 export declare function enabledFeaturesForPersonalAccessKey(accountId: number): Promise<{
     [key: string]: number;
 } | undefined>;
+export declare function scopesOnAccessToken(accountId: number): Promise<Array<string>>;
 export declare function updateConfigWithAccessToken(token: AccessToken, personalAccessKey: string, env?: Environment, name?: string, makeDefault?: boolean): Promise<CLIAccount | null>;
-export {};

package/lib/personalAccessKey.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateConfigWithAccessToken = exports.enabledFeaturesForPersonalAccessKey = exports.accessTokenForPersonalAccessKey = exports.getAccessToken = void 0;
+exports.updateConfigWithAccessToken = exports.scopesOnAccessToken = exports.enabledFeaturesForPersonalAccessKey = exports.accessTokenForPersonalAccessKey = exports.getAccessToken = void 0;
 const moment_1 = __importDefault(require("moment"));
 const environments_1 = require("../constants/environments");
 const auth_1 = require("../constants/auth");
@@ -83,6 +83,15 @@ async function getNewAccessToken(accountId, personalAccessKey, expiresAt, env) {
     }
     return accessTokenResponse;
 }
+async function getNewAccessTokenByAccountId(accountId) {
+    const account = (0, config_1.getAccountConfig)(accountId);
+    if (!account) {
+        (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.accountNotFound`, { accountId });
+    }
+    const { auth, personalAccessKey, env } = account;
+    const accessTokenResponse = await getNewAccessToken(accountId, personalAccessKey, auth?.tokenInfo?.expiresAt, env);
+    return accessTokenResponse;
+}
 async function accessTokenForPersonalAccessKey(accountId) {
     const account = (0, config_1.getAccountConfig)(accountId);
     if (!account) {
@@ -99,16 +108,14 @@ async function accessTokenForPersonalAccessKey(accountId) {
 }
 exports.accessTokenForPersonalAccessKey = accessTokenForPersonalAccessKey;
 async function enabledFeaturesForPersonalAccessKey(accountId) {
-    const account = (0, config_1.getAccountConfig)(accountId);
-    if (!account) {
-        (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.accountNotFound`, { accountId });
-    }
-    const { auth, personalAccessKey, env } = account;
-    const authTokenInfo = auth && auth.tokenInfo;
-    const accessTokenResponse = await getNewAccessToken(accountId, personalAccessKey, authTokenInfo && authTokenInfo.expiresAt, env);
+    const accessTokenResponse = await getNewAccessTokenByAccountId(accountId);
     return accessTokenResponse?.enabledFeatures;
 }
 exports.enabledFeaturesForPersonalAccessKey = enabledFeaturesForPersonalAccessKey;
+async function scopesOnAccessToken(accountId) {
+    return (await getNewAccessTokenByAccountId(accountId)).scopeGroups;
+}
+exports.scopesOnAccessToken = scopesOnAccessToken;
 async function updateConfigWithAccessToken(token, personalAccessKey, env, name, makeDefault = false) {
     const { portalId, accessToken, expiresAt, accountType } = token;
     const accountEnv = env || (0, config_1.getEnv)(name);

package/lib/portManager.d.ts

@@ -1,13 +1,9 @@
+import { RequestPortsData } from '../types/PortManager';
 export declare const BASE_URL: string;
 export declare function startPortManagerServer(): Promise<void>;
 export declare function stopPortManagerServer(): Promise<void>;
-type RequestPortsData = {
-    instanceId: string;
-    port?: number;
-};
 export declare function requestPorts(portData: Array<RequestPortsData>): Promise<{
     [instanceId: string]: number;
 }>;
 export declare function deleteServerInstance(serverInstanceId: string): Promise<void>;
 export declare function portManagerHasActiveServers(): Promise<boolean>;
-export {};

package/models/OAuth2Manager.d.ts

@@ -1,28 +1,4 @@
-import { FlatAccountFields, TokenInfo } from '../types/Accounts';
-import { Environment } from '../types/Config';
-type OAuth2ManagerAccountConfig = {
-    name?: string;
-    accountId?: number;
-    clientId?: string;
-    clientSecret?: string;
-    scopes?: Array<string>;
-    env?: Environment;
-    environment?: Environment;
-    tokenInfo?: TokenInfo;
-    authType?: 'oauth2';
-};
-type WriteTokenInfoFunction = (tokenInfo: TokenInfo) => void;
-type RefreshTokenResponse = {
-    refresh_token: string;
-    access_token: string;
-    expires_in: string;
-};
-type ExchangeProof = {
-    grant_type: string;
-    client_id?: string;
-    client_secret?: string;
-    refresh_token?: string;
-};
+import { FlatAccountFields, OAuth2ManagerAccountConfig, WriteTokenInfoFunction, RefreshTokenResponse, ExchangeProof } from '../types/Accounts';
 declare class OAuth2Manager {
     account: OAuth2ManagerAccountConfig;
     writeTokenInfo?: WriteTokenInfoFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "1.9.0",
+    "version": "1.10.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {
@@ -54,7 +54,8 @@
         "./http/*": "./http/*.js",
         "./config": "./config/index.js",
         "./constants/*": "./constants/*.js",
-        "./models/*": "./models/*.js"
+        "./models/*": "./models/*.js",
+        "./types/*": "./types/*.d.ts"
     },
     "dependencies": {
         "address": "^2.0.1",

package/types/Accounts.d.ts

@@ -34,6 +34,10 @@ 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;
@@ -98,3 +102,72 @@ 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 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

@@ -13,6 +13,11 @@ export type PublicAppDeveloperTestAccountInstallData = {
     }>;
     testPortalInstallCount: string;
 };
+export type PublicAppInstallCounts = {
+    uniquePortalInstallCount: number;
+    uniqueUserInstallCount: number;
+    uniqueBusinessUnitInstallCount: number;
+};
 export type PublicApp = {
     id: number;
     name: string;
@@ -34,11 +39,7 @@ export type PublicApp = {
     supportPhone: string | null;
     extensionIconUrl: string | null;
     isAdvancedScopesSettingEnabled: boolean;
-    publicApplicationInstallCounts: {
-        uniquePortalInstallCount: number;
-        uniqueUserInstallCount: number;
-        uniqueBusinessUnitInstallCount: number;
-    };
+    publicApplicationInstallCounts: PublicAppInstallCounts;
     redirectUrls: Array<string>;
     scopeGroupIds: Array<number>;
     requiredScopeInfo?: Array<{
@@ -71,3 +72,6 @@ export type PublicApp = {
     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/Config.d.ts

@@ -21,3 +21,17 @@ export interface CLIConfig_DEPRECATED {
 }
 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/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

@@ -31,3 +31,6 @@ export type AxiosErrorContext = {
     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

@@ -68,3 +68,4 @@ export type FetchFolderResponse = {
     objects: Array<Folder>;
     total_count: number;
 };
+export type SimplifiedFolder = Partial<Folder> & Pick<Folder, 'id' | 'name'>;

package/types/Files.d.ts

@@ -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: AxiosError) => void;
+    onRetryCallback?: (file: string, destPath: string) => void;
+    onFinalErrorCallback?: (accountId: number, file: string, destPath: string, error: AxiosError) => void;
+};
+export type FilePathsByType = {
+    [key: string]: Array<string>;
+};
+export type UploadFileOptions = FileMapperInputOptions & {
+    src: string;
+    commandOptions: {
+        convertFields?: boolean;
+    };
+    fieldOptions?: string;
+};
+export type WatchOptions = {
+    mode?: Mode;
+    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,30 @@ 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 {};

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/Modules.d.ts

@@ -3,3 +3,13 @@ export type PathInput = {
     isHubSpot?: boolean;
     path: string;
 };
+export type ValidationResult = {
+    id: string;
+    message: string;
+};
+export type ModuleDefinition = {
+    contentTypes: Array<string>;
+    moduleLabel: string;
+    reactType: boolean;
+    global: boolean;
+};

package/types/PortManager.d.ts

@@ -2,3 +2,10 @@ export type RequestPortsData = {
     instanceId: string;
     port?: number;
 };
+export type NetError = Error & {
+    code: string;
+};
+export type ListenCallback = (error: NetError | null, port: number) => void;
+export type ServerPortMap = {
+    [instanceId: string]: number;
+};

package/types/Project.d.ts

@@ -36,3 +36,7 @@ export type UploadProjectResponse = {
 export type ProjectSettings = {
     isAutoDeployEnabled: boolean;
 };
+export type FetchPlatformVersionResponse = {
+    defaultPlatformVersion: string;
+    activePlatformVersions: Array<string>;
+};

package/types/Schemas.d.ts

@@ -25,3 +25,15 @@ export type Schema = {
 export type FetchSchemasResponse = {
     results: Array<Schema>;
 };
+export type CreateObjectsResponse = {
+    status: string;
+    startedAt: string;
+    completedAt: string;
+    results: Array<{
+        id: string;
+        properties: Array<any>;
+        createdAt: string;
+        updatedAt: string;
+        archived: boolean;
+    }>;
+};

package/types/Secrets.d.ts

@@ -0,0 +1,3 @@
+export type FetchSecretsResponse = {
+    results: Array<string>;
+};

package/types/Secrets.js

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

package/utils/PortManagerServer.d.ts

@@ -1,10 +1,7 @@
 /// <reference types="node" />
 import { Express, Request, Response } from 'express';
 import { Server } from 'http';
-import { RequestPortsData } from '../types/PortManager';
-type ServerPortMap = {
-    [instanceId: string]: number;
-};
+import { RequestPortsData, ServerPortMap } from '../types/PortManager';
 declare class PortManagerServer {
     app?: Express;
     server?: Server;

package/utils/cms/fieldsJS.d.ts

@@ -1,3 +1,2 @@
-type FieldsArray<T> = Array<T | FieldsArray<T>>;
+import { FieldsArray } from '../../types/FieldsJS';
 export declare function fieldsArrayToJson<T>(fields: FieldsArray<T>): string;
-export {};

package/utils/getAccountIdentifier.d.ts

@@ -1,10 +1,5 @@
-import { CLIAccount } from '../types/Accounts';
+import { CLIAccount, GenericAccount } from '../types/Accounts';
 import { CLIConfig } from '../types/Config';
-type Account = {
-    portalId?: number;
-    accountId?: number;
-};
-export declare function getAccountIdentifier(account?: Account | null): number | undefined;
+export declare function getAccountIdentifier(account?: GenericAccount | null): number | undefined;
 export declare function getAccounts(config?: CLIConfig | null): Array<CLIAccount>;
 export declare function getDefaultAccount(config?: CLIConfig | null): string | number | undefined;
-export {};