@hubspot/local-dev-lib 0.1.7-experimental.0 → 0.1.9-experimental.0

package/api/customObjects.d.ts

@@ -1,6 +1,5 @@
-import { FetchSchemasResponse, Schema, SchemaDefinition, CreateObjectsResponse } from '../types/Schemas';
+import { FetchSchemasResponse, Schema, SchemaDefinition, ObjectDefinition, CreateObjectsResponse } from '../types/Schemas';
 import { HubSpotPromise } from '../types/Http';
-import { ObjectDefinition } from '../types/CustomObject';
 export declare function batchCreateObjects(accountId: number, objectTypeId: string, objects: ObjectDefinition): HubSpotPromise<CreateObjectsResponse>;
 export declare function createObjectSchema(accountId: number, schema: SchemaDefinition): HubSpotPromise<Schema>;
 export declare function updateObjectSchema(accountId: number, schemaObjectType: string, schema: SchemaDefinition): HubSpotPromise<Schema>;

package/config/migrate.d.ts

@@ -0,0 +1,7 @@
+import { CLIConfig, CLIConfig_DEPRECATED, CLIConfig_NEW } from '../types/Config';
+export declare function getConfig(useHiddenConfig?: boolean): Partial<CLIConfig> | null;
+export declare function getConfigPath(path?: string, useHiddenConfig?: boolean): string | null;
+export declare function configFileExists(useHiddenConfig?: boolean, configPath?: string): boolean;
+export declare function deleteConfigFile(useHiddenConfig?: boolean): void;
+export declare function migrateConfig(deprecatedConfig: CLIConfig_DEPRECATED | null): void;
+export declare function mergeExistingConfigs(globalConfig: CLIConfig_NEW, deprecatedConfig: CLIConfig_DEPRECATED): void;

package/config/migrate.js

@@ -0,0 +1,144 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeExistingConfigs = exports.migrateConfig = exports.deleteConfigFile = exports.configFileExists = exports.getConfigPath = exports.getConfig = void 0;
+const config_DEPRECATED = __importStar(require("./config_DEPRECATED"));
+const CLIConfiguration_1 = require("./CLIConfiguration");
+const index_1 = require("./index");
+const configFile_1 = require("./configFile");
+const config_1 = require("../constants/config");
+const lang_1 = require("../utils/lang");
+const logger_1 = require("../lib/logger");
+const i18nKey = 'config.migrate';
+function getConfig(useHiddenConfig = false) {
+    if (useHiddenConfig) {
+        return CLIConfiguration_1.CLIConfiguration.config;
+    }
+    return config_DEPRECATED.getAndLoadConfigIfNeeded();
+}
+exports.getConfig = getConfig;
+function getConfigPath(path, useHiddenConfig = false) {
+    if (useHiddenConfig) {
+        return (0, configFile_1.getConfigFilePath)();
+    }
+    return config_DEPRECATED.getConfigPath(path);
+}
+exports.getConfigPath = getConfigPath;
+function configFileExists(useHiddenConfig, configPath) {
+    return useHiddenConfig
+        ? (0, configFile_1.configFileExists)()
+        : Boolean(config_DEPRECATED.getConfigPath(configPath));
+}
+exports.configFileExists = configFileExists;
+function deleteConfigFile(useHiddenConfig = false) {
+    if (useHiddenConfig) {
+        (0, configFile_1.deleteConfigFile)();
+    }
+    config_DEPRECATED.deleteConfigFile();
+}
+exports.deleteConfigFile = deleteConfigFile;
+function writeGlobalConfigFile(updatedConfig) {
+    const updatedConfigJson = JSON.stringify(updatedConfig);
+    (0, index_1.createEmptyConfigFile)({}, true);
+    (0, index_1.loadConfig)('');
+    try {
+        (0, index_1.writeConfig)({ source: updatedConfigJson });
+        deleteConfigFile();
+    }
+    catch (error) {
+        (0, index_1.deleteEmptyConfigFile)();
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.writeConfig`, { configPath: config_1.GLOBAL_CONFIG_PATH }), { cause: error });
+    }
+}
+function migrateConfig(deprecatedConfig) {
+    if (!deprecatedConfig) {
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.noDefaultConfig`));
+    }
+    const { defaultPortal, portals, ...rest } = deprecatedConfig;
+    const updatedConfig = {
+        ...rest,
+        defaultAccount: defaultPortal,
+        accounts: portals
+            .filter(({ portalId }) => portalId !== undefined)
+            .map(({ portalId, ...rest }) => ({
+            ...rest,
+            accountId: portalId,
+        })),
+    };
+    writeGlobalConfigFile(updatedConfig);
+}
+exports.migrateConfig = migrateConfig;
+function mergeConfigPropertes(globalConfig, deprecatedConfig) {
+    const propertiesToCheck = [
+        'defaultCmsPublishMode',
+        'httpTimeout',
+        'allowUsageTracking',
+        'env',
+    ];
+    const conflicts = [];
+    propertiesToCheck.forEach(prop => {
+        if (prop in globalConfig && prop in deprecatedConfig) {
+            if (globalConfig[prop] !== deprecatedConfig[prop]) {
+                conflicts.push({
+                    property: prop,
+                    oldValue: deprecatedConfig[prop],
+                    newValue: globalConfig[prop],
+                });
+            }
+        }
+        else {
+            // @ts-expect-error TODO
+            globalConfig[prop] = deprecatedConfig[prop];
+        }
+    });
+    if (conflicts.length > 0) {
+        logger_1.logger.log(`The following properties have different values in the deprecated and global config files:\n${conflicts
+            .map(({ property, oldValue, newValue }) => `${property}: ${oldValue} (deprecated) vs ${newValue} (global)`)
+            .join('\n')}`);
+        return globalConfig;
+    }
+    return globalConfig;
+}
+function mergeAccounts(globalConfig, deprecatedConfig) {
+    if (globalConfig.accounts && deprecatedConfig.portals) {
+        const existingPortalIds = new Set(globalConfig.accounts.map(account => account.accountId));
+        const newAccounts = deprecatedConfig.portals
+            .filter(portal => !existingPortalIds.has(portal.portalId))
+            .map(({ portalId, ...rest }) => ({
+            ...rest,
+            accountId: portalId,
+        }));
+        if (newAccounts.length > 0) {
+            globalConfig.accounts.push(...newAccounts);
+        }
+    }
+    return globalConfig;
+}
+function mergeExistingConfigs(globalConfig, deprecatedConfig) {
+    const updatedConfig = mergeConfigPropertes(globalConfig, deprecatedConfig);
+    const finalConfig = mergeAccounts(updatedConfig, deprecatedConfig);
+    writeGlobalConfigFile(finalConfig);
+}
+exports.mergeExistingConfigs = mergeExistingConfigs;

package/constants/config.d.ts

@@ -1,6 +1,7 @@
 export declare const DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = "hubspot.config.yml";
 export declare const HUBSPOT_CONFIGURATION_FOLDER = ".hscli";
 export declare const HUBSPOT_CONFIGURATION_FILE = "config.yml";
+export declare const GLOBAL_CONFIG_PATH: string;
 export declare const DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = ".hsaccount";
 export declare const DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = "DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID";
 export declare const DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = "DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND";

package/constants/config.js

@@ -1,10 +1,15 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
+exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = exports.GLOBAL_CONFIG_PATH = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
 const lang_1 = require("../utils/lang");
+const os_1 = __importDefault(require("os"));
 exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = 'hubspot.config.yml';
 exports.HUBSPOT_CONFIGURATION_FOLDER = '.hscli';
 exports.HUBSPOT_CONFIGURATION_FILE = 'config.yml';
+exports.GLOBAL_CONFIG_PATH = `${os_1.default.homedir()}/${exports.HUBSPOT_CONFIGURATION_FOLDER}/${exports.HUBSPOT_CONFIGURATION_FILE}`;
 exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = '.hsaccount';
 exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = 'DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID';
 exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = 'DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND';

package/lang/en.json

@@ -311,6 +311,12 @@
         "missingEnv": "Unable to load config from environment variables: Missing env",
         "unknownAuthType": "Unable to load config from environment variables: Unknown auth type"
       }
+    },
+    "migrate": {
+      "errors": {
+        "writeConfig": "Unable to write global configuration file at {{ configPath }}",
+        "noDefaultConfig": "No default configuration file found. Skipping migration to global config."
+      }
     }
   },
   "models": {

package/lib/github.d.ts

@@ -1,5 +1,8 @@
 /// <reference types="node" />
 import { GithubReleaseData, GithubRepoFile, RepoPath, CloneGithubRepoOptions } from '../types/Github';
+/**
+ * @deprecated Use `fetchRepoFile` instead - this util is a thin wrapper around it
+ */
 export declare function fetchFileFromRepository<T = Buffer>(repoPath: RepoPath, filePath: string, ref: string): Promise<T>;
 export declare function fetchReleaseData(repoPath: RepoPath, tag?: string): Promise<GithubReleaseData>;
 export declare function cloneGithubRepo(repoPath: RepoPath, dest: string, options?: CloneGithubRepoOptions): Promise<boolean>;

package/lib/github.js

@@ -12,6 +12,9 @@ const github_1 = require("../api/github");
 const lang_1 = require("../utils/lang");
 const errors_1 = require("../errors");
 const i18nKey = 'lib.github';
+/**
+ * @deprecated Use `fetchRepoFile` instead - this util is a thin wrapper around it
+ */
 async function fetchFileFromRepository(repoPath, filePath, ref) {
     try {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.fetchFileFromRepository.fetching`, {
@@ -75,14 +78,17 @@ async function downloadGithubRepoZip(repoPath, isRelease = false, options = {})
     }
 }
 async function cloneGithubRepo(repoPath, dest, options = {}) {
-    const { tag, isRelease, branch, sourceDir, type } = options;
+    const { tag, isRelease, branch, sourceDir, type, hideLogs } = options;
     const zip = await downloadGithubRepoZip(repoPath, isRelease, {
         tag,
         branch,
     });
     const repoName = repoPath.split('/')[1];
-    const success = await (0, archive_1.extractZipArchive)(zip, repoName, dest, { sourceDir });
-    if (success) {
+    const success = await (0, archive_1.extractZipArchive)(zip, repoName, dest, {
+        sourceDir,
+        hideLogs,
+    });
+    if (success && !hideLogs) {
         logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.cloneGithubRepo.success`, {
             type: type || '',
             dest,

package/package.json

@@ -1,8 +1,7 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.1.7-experimental.0",
+    "version": "0.1.9-experimental.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
-    "main": "lib/index.js",
     "repository": {
         "type": "git",
         "url": "https://github.com/HubSpot/hubspot-local-dev-lib"
@@ -51,6 +50,7 @@
         "./http": "./http/index.js",
         "./http/*": "./http/*.js",
         "./config/getAccountIdentifier": "./config/getAccountIdentifier.js",
+        "./config/migrate": "./config/migrate.js",
         "./config": "./config/index.js",
         "./constants/*": "./constants/*.js",
         "./models/*": "./models/*.js",

package/types/Github.d.ts

@@ -72,5 +72,6 @@ export type CloneGithubRepoOptions = {
     branch?: string;
     tag?: string;
     sourceDir?: string;
+    hideLogs?: boolean;
 };
 export {};

package/types/Schemas.d.ts

@@ -58,3 +58,26 @@ export type SchemaDefinition = {
     ];
     requiredProperties: Array<string>;
 };
+export type ObjectDefinition = {
+    inputs: [
+        {
+            associations?: [
+                {
+                    types: [
+                        {
+                            associationCategory: string;
+                            associationTypeId: number;
+                        }
+                    ];
+                    to: {
+                        id: string;
+                    };
+                }
+            ];
+            objectWriteTraceId?: number;
+            properties: {
+                [key: string]: string;
+            };
+        }
+    ];
+};

package/types/CustomObject.d.ts

@@ -1,23 +0,0 @@
-export type ObjectDefinition = {
-    inputs: [
-        {
-            associations?: [
-                {
-                    types: [
-                        {
-                            associationCategory: string;
-                            associationTypeId: number;
-                        }
-                    ];
-                    to: {
-                        id: string;
-                    };
-                }
-            ];
-            objectWriteTraceId?: number;
-            properties: {
-                [key: string]: string;
-            };
-        }
-    ];
-};

package/types/CustomObject.js

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