@hubspot/local-dev-lib 2.1.1 → 2.1.2-beta.0

package/lib/oauth.js

@@ -4,7 +4,7 @@ exports.addOauthToAccountConfig = exports.getOauthManager = void 0;
 const OAuth2Manager_1 = require("../models/OAuth2Manager");
 const auth_1 = require("../constants/auth");
 const logger_1 = require("./logger");
-const getAccountIdentifier_1 = require("../utils/getAccountIdentifier");
+const getAccountIdentifier_1 = require("../config/getAccountIdentifier");
 const config_1 = require("../config");
 const lang_1 = require("../utils/lang");
 const i18nKey = 'lib.oauth';

package/lib/personalAccessKey.js

@@ -13,6 +13,7 @@ const config_1 = require("../config");
 const config_2 = require("../constants/config");
 const developerTestAccounts_1 = require("../api/developerTestAccounts");
 const logger_1 = require("./logger");
+const CLIConfiguration_1 = require("../config/CLIConfiguration");
 const lang_1 = require("../utils/lang");
 const errors_1 = require("../errors");
 const i18nKey = 'lib.personalAccessKey';
@@ -141,7 +142,7 @@ async function updateConfigWithAccessToken(token, personalAccessKey, env, name,
         }
         logger_1.logger.debug(err);
     }
-    const updatedConfig = (0, config_1.updateAccountConfig)({
+    const updatedAccount = (0, config_1.updateAccountConfig)({
         accountId: portalId,
         accountType,
         personalAccessKey,
@@ -151,10 +152,12 @@ async function updateConfigWithAccessToken(token, personalAccessKey, env, name,
         parentAccountId,
         env: accountEnv,
     });
-    (0, config_1.writeConfig)();
+    if (!CLIConfiguration_1.CLIConfiguration.isActive()) {
+        (0, config_1.writeConfig)();
+    }
     if (makeDefault && name) {
         (0, config_1.updateDefaultAccount)(name);
     }
-    return updatedConfig;
+    return updatedAccount;
 }
 exports.updateConfigWithAccessToken = updateConfigWithAccessToken;

package/models/OAuth2Manager.js

@@ -9,7 +9,7 @@ const moment_1 = __importDefault(require("moment"));
 const urls_1 = require("../lib/urls");
 const environment_1 = require("../lib/environment");
 const logger_1 = require("../lib/logger");
-const getAccountIdentifier_1 = require("../utils/getAccountIdentifier");
+const getAccountIdentifier_1 = require("../config/getAccountIdentifier");
 const auth_1 = require("../constants/auth");
 const lang_1 = require("../utils/lang");
 const i18nKey = 'models.OAuth2Manager';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "2.1.1",
+    "version": "2.1.2-beta.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {
@@ -12,22 +12,16 @@
         "access": "public"
     },
     "scripts": {
-        "build": "rm -rf ./dist/ && tsc --rootDir . --outdir dist && yarn copy-files && yarn clear-postinstall",
-        "check-main": "branch=$(git rev-parse --abbrev-ref HEAD) && [ $branch = main ] || (echo 'Error: New release can only be published on main branch' && exit 1)",
-        "clear-postinstall": "cd dist && npm pkg delete scripts.postinstall",
-        "copy-files": "cp -r lang dist/lang",
+        "build": "ts-node ./scripts/build.ts",
         "lint": "eslint --max-warnings=0 . && prettier . --check",
         "local-dev": "yarn build && cd dist && yarn link && cd .. && tsc --watch --rootDir . --outdir dist",
         "prettier:write": "prettier . --write",
-        "pub": "cd dist && npm publish --tag latest && cd ..",
-        "push": "git push --atomic origin main v$npm_package_version",
-        "release:major": "yarn check-main && yarn version --major && yarn build && yarn pub && yarn push",
-        "release:minor": "yarn check-main && yarn version --minor && yarn build && yarn pub && yarn push",
-        "release:patch": "yarn check-main && yarn version --patch && yarn build && yarn pub && yarn push",
+        "release": "ts-node ./scripts/release.ts release",
         "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ./node_modules/.bin/jest"
     },
     "license": "Apache-2.0",
     "devDependencies": {
+        "@inquirer/prompts": "^7.0.1",
         "@types/content-disposition": "^0.5.5",
         "@types/cors": "^2.8.15",
         "@types/debounce": "^1.2.1",
@@ -45,7 +39,9 @@
         "husky": "^8.0.0",
         "jest": "^29.5.0",
         "ts-jest": "^29.0.5",
-        "typescript": "^4.9.5"
+        "ts-node": "^10.9.2",
+        "typescript": "^4.9.5",
+        "yargs": "^17.7.2"
     },
     "exports": {
         "./*": "./lib/*.js",
@@ -53,6 +49,7 @@
         "./errors/*": "./errors/*.js",
         "./http": "./http/index.js",
         "./http/*": "./http/*.js",
+        "./config/getAccountIdentifier": "./config/getAccountIdentifier.js",
         "./config": "./config/index.js",
         "./constants/*": "./constants/*.js",
         "./models/*": "./models/*.js",

package/utils/{getAccountIdentifier.d.ts → accounts.d.ts}

@@ -1,5 +1,4 @@
-import { CLIAccount, GenericAccount } from '../types/Accounts';
+import { CLIAccount } from '../types/Accounts';
 import { CLIConfig } from '../types/Config';
-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;

package/utils/{getAccountIdentifier.js → accounts.js}

@@ -1,18 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultAccount = exports.getAccounts = exports.getAccountIdentifier = void 0;
-function getAccountIdentifier(account) {
-    if (!account) {
-        return undefined;
-    }
-    else if (Object.hasOwn(account, 'portalId')) {
-        return account.portalId;
-    }
-    else if (Object.hasOwn(account, 'accountId')) {
-        return account.accountId;
-    }
-}
-exports.getAccountIdentifier = getAccountIdentifier;
+exports.getDefaultAccount = exports.getAccounts = void 0;
 function getAccounts(config) {
     if (!config) {
         return [];

package/lang/lang/en.json

@@ -1,389 +0,0 @@
-{
-  "lib": {
-    "trackUsage": {
-      "invalidEvent": "Usage tracking event {{ eventName }} is not a valid event type.",
-      "sendingEventAuthenticated": "Sending usage event to authenticated endpoint",
-      "retryingEventUnauthenticated": "Failed to send the usage event as authenticated. Trying again as unauthenticated.",
-      "sendingEventUnauthenticated": "Sending usage event to unauthenticated endpoint"
-    },
-    "archive": {
-      "extractZip": {
-        "init": "Extracting project source...",
-        "success": "Completed project source extraction.",
-        "errors": {
-          "write": "An error occurred writing temp project source.",
-          "extract": "An error occurred extracting project source."
-        }
-      },
-      "copySourceToDest": {
-        "init": "Copying project source...",
-        "sourceEmpty": "Project source is empty",
-        "success": "Completed copying project source.",
-        "error": "An error occurred copying project source to {{ dest }}."
-      },
-      "cleanupTempDir": {
-        "error": "Failed to clean up temp dir: {{ tmpDir }}"
-      }
-    },
-    "gitignore": {
-      "errors": {
-        "configIgnore": "Unable to determine if config file is properly ignored by git."
-      }
-    },
-    "github": {
-      "fetchFileFromRepository": {
-        "fetching": "Fetching {{ path }}...",
-        "errors": {
-          "fetchFail": "An error occurred fetching JSON file."
-        }
-      },
-      "fetchReleaseData": {
-        "errors": {
-          "fetchFail": "Failed fetching release data for {{ tag }} project."
-        }
-      },
-      "downloadGithubRepoZip": {
-        "fetching": "Fetching repository with name {{ repoPath }}...",
-        "fetchingName": "Fetching {{ name }}...",
-        "completed": "Completed project fetch.",
-        "errors": {
-          "fetchFail": "An error occurred fetching the project source."
-        }
-      },
-      "cloneGithubRepo": {
-        "success": "Your new {{ type }} has been created in {{ dest }}"
-      },
-      "downloadGithubRepoContents": {
-        "downloading": "Downloading content piece: {{ contentPiecePath }} from {{ downloadUrl }} to {{ downloadPath }}",
-        "errors": {
-          "fetchFail": "Failed to fetch contents: {{ errorMessage }}"
-        }
-      },
-      "listGitHubRepoContents": {
-        "errors": {
-          "fetchFail": "Failed to fetch contents: {{ errorMessage }}"
-        }
-      }
-    },
-    "hubdb": {
-      "errors": {
-        "invalidJsonPath": "The HubDB table file must be a '.json' file",
-        "invalidJsonFile": "The '{{{ src }}' path is not a path to a file"
-      }
-    },
-    "personalAccessKey": {
-      "errors": {
-        "accountNotFound": "Account with id {{ accountId }} does not exist.",
-        "invalidPersonalAccessKey": "Error while retrieving new access token: {{ errorMessage }}"
-      }
-    },
-    "cms": {
-      "modules": {
-        "createModule": {
-          "creatingModule": "Creating module at {{ path }}",
-          "creatingPath": "Creating {{ path }}",
-          "errors": {
-            "pathExists": "The {{ path }} path already exists",
-            "fileUpdateFailure": "There was a problem updating the modules files at {{ path }}: {{ errorMessage }}"
-          }
-        },
-        "retrieveDefaultModule": {
-          "errors": {
-            "pathExists": "Folder already exists at \"{{ path }}\""
-          }
-        }
-      },
-      "functions": {
-        "updateExistingConfig": {
-          "unableToReadFile": "The file {{ configFilePath }} could not be read",
-          "invalidJSON": "The file {{ configFilePath }} is not valid JSON",
-          "couldNotUpdateFile": "The file {{ configFilePath }} could not be updated",
-          "errors": {
-            "configIsNotObjectError": "The existing {{ configFilePath }} is not an object",
-            "endpointAreadyExistsError": "The endpoint {{ endpointPath }} already exists in {{ configFilePath }}"
-          }
-        },
-        "createFunction": {
-          "destPathAlreadyExists": "The {{ path }} path already exists",
-          "createdDest": "Created {{ path }}",
-          "failedToCreateFile": "The file {{ configFilePath }} could not be created",
-          "createdFunctionFile": "Created {{ path }}",
-          "createdConfigFile": "Created {{ path }}",
-          "success": "A function for the endpoint '/_hcms/api/{{ endpointPath }}' has been created. Upload {{ folderName }} to try it out",
-          "errors": {
-            "nestedConfigError": "Cannot create a functions directory inside '{{ ancestorConfigPath }}'",
-            "jsFileConflictError": "The JavaScript file at '{{ functionFilePath }}'' already exists"
-          }
-        }
-      },
-      "handleFieldsJs": {
-        "convertFieldsJs": {
-          "creating": "Creating child process with pid {{ pid }}",
-          "terminating": "Child process with pid {{ pid }} has been terminated",
-          "errors": {
-            "errorConverting": "There was an error converting '{{ filePath }}'"
-          }
-        },
-        "saveOutput": {
-          "errors": {
-            "saveFailed": "There was an error saving the json output of {{ path }}"
-          }
-        },
-        "createTmpDirSync": {
-          "errors": {
-            "writeFailed": "An error occurred writing temporary project source."
-          }
-        },
-        "cleanupTmpDirSync": {
-          "errors": {
-            "deleteFailed": "There was an error deleting the temporary project source"
-          }
-        }
-      },
-      "uploadFolder": {
-        "uploadFolder": {
-          "success": "Uploaded file \"{{ file}}\" to \"{{ destPath }}\"",
-          "attempt": "Attempting to upload file \"{{ file }}\" to \"{{ destPath }}\"",
-          "failed": "Uploading file \"{{ file }}\" to \"{{ destPath }}\" failed so scheduled retry",
-          "retry": "Retrying to upload file \"{{ file }}\" to \"{{ destPath }}\"",
-          "retryFailed": "Uploading file \"{{ file }}\" to \"{{ destPath }}\" failed"
-        }
-      },
-      "templates": {
-        "createTemplate": {
-          "creatingFile": "Creating file at {{ path }}",
-          "creatingPath": "Making {{ path }} if needed",
-          "errors": {
-            "pathExists": "The {{ path }} path already exists"
-          }
-        }
-      },
-      "processFieldsJs": {
-        "converting": "Converting \"{{ src }}\" to \"{{ dest }}\".",
-        "converted": "Finished converting \"{{ src }}\" to \"{{ dest }}\".",
-        "errors": {
-          "invalidMjsFile": ".mjs files are only supported when using Node 13.2.0+",
-          "notFunction": "There was an error loading JS file \"{{ path }}\". Expected type \"Function\" but received type \"{{ returned }}\". Make sure that your default export is a function.",
-          "notArray": "There was an error loading JS file \"{{ path }}\". Expected type \"Array\" but received type \"{{ returned }}\" . Make sure that your function returns an array"
-        }
-      },
-      "watch": {
-        "notifyOfThemePreview": "To preview this theme, visit: {{ previewUrl }}",
-        "skipUnsupportedExtension": "Skipping {{ file }} due to unsupported extension",
-        "skipIgnoreRule": "Skipping {{ file }} due to an ignore rule",
-        "uploadAttempt": "Attempting to upload file \"{{ file }}\" to \"{{ dest }}\"",
-        "uploadSuccess": "Uploaded file {{ file }} to {{ dest }}",
-        "uploadFailed": "Uploading file {{ file }} to {{ dest }} failed",
-        "uploadRetry": "Retrying to upload file \"{{ file }}\" to \"{{ dest }}\"",
-        "deleteAttempt": "Attempting to delete file {{ remoteFilePath }}",
-        "deleteAttemptWithType": "Attempting to delete {{ type }} {{ remoteFilePath }}",
-        "deleteSuccess": "Deleted file {{ remoteFilePath }}",
-        "deleteSuccessWithType": "Deleted {{ type }} {{ remoteFilePath }}",
-        "deleteFailed": "Deleting file {{ remoteFilePath }} failed",
-        "folderUploadSuccess": "Completed uploading files in {{ src }} to {{ dest }} in {{ accountId }}",
-        "ready": "Watcher is ready and watching {{ src }}. Any changes detected will be automatically uploaded and overwrite the current version in the developer file system."
-      }
-    },
-    "oauth": {
-      "writeTokenInfo": "Updating Oauth2 token info for portalId: {{ portalId }}",
-      "addOauthToAccountConfig": {
-        "init": "Updating configuration",
-        "success": "Configuration updated"
-      }
-    },
-    "fileManager": {
-      "uploadStarted": "Uploading files from \"{{ file }}\" to \"{{ destPath }}\" in the File Manager of account {{ accountId }}",
-      "uploadSuccess": "Uploaded file \"{{ file }}\" to \"{{ destPath }}\"",
-      "skippedExisting": "Skipped existing {{ filepath }}",
-      "fetchingFiles": "Fetching {{ fileCount }} files from remote folder: {{ folderName }}",
-      "fetchFolderStarted": "Fetching folder from \"{{ src }}\" to \"{{ path }}\" in the File Manager of account {{ accountId }}",
-      "fetchFolderSuccess": "Completed fetch of folder \"{{ src }}\" to \"{{ dest }}\" from the File Manager",
-      "fetchFileStarted": "Fetching file from \"{{ src }}\" to \"{{ dest }}\" in the File Manager of account {{ accountId }}",
-      "fetchFileSuccess": "Completed fetch of file \"{{ src }}\" to \"{{ dest }}\" from the File Manager",
-      "errors": {
-        "uploadFailed": "Uploading file \"{{ file }}\" to \"{{ destPath }}\" failed",
-        "archivedFile": "\"{{ src }} \" in the File Manager is an archived file. Try fetching again with the \"--include-archived\" flag",
-        "hiddenFile": "\"{{ src }}\" in the File Manager is a hidden file."
-      }
-    },
-    "fileMapper": {
-      "skippedExisting": "Skipped existing {{ filepath }}",
-      "wroteFolder": "Wrote folder {{ filepath }}",
-      "completedFetch": "Completed fetch of file \"{{ src }}\"{{ version }} to \"{{ dest }}\" from the Design Manager",
-      "folderFetch": "Fetched \"{{ src }}\" from account {{ accountId }} from the Design Manager successfully",
-      "completedFolderFetch": "Completed fetch of folder \"{{ src }}\"{{ version }} to \"{{ dest }}\" from the Design Manager",
-      "errors": {
-        "invalidRequest": "Invalid request for file: {{ src }}",
-        "invalidNode": "Invalid FileMapperNode: {{ json }}",
-        "invalidFileType": "Invalid file type requested: {{ srcPath }}",
-        "assetTimeout": "HubSpot assets are unavailable at the moment. Please wait a few minutes and try again.",
-        "failedToFetchFile": "Failed fetch of file \"{{ src }}\" to \"{{ dest }}\" from the Design Manager",
-        "failedToFetchFolder": "Failed fetch of folder \"{{ src }}\" to \"{{ dest }}\" from the Design Manager",
-        "invalidFetchFolderRequest": "Invalid request for folder: \"{{ src }}\"",
-        "incompleteFetch": "Not all files in folder \"{{ src }}\" were successfully fetched.  Re-run the last command to try again"
-      }
-    },
-    "accountTypes": {
-      "developmentSandbox": "dev sandbox",
-      "standardSandbox": "standard sandbox",
-      "developerTest": "test account",
-      "appDeveloper": "dev account",
-      "standard": "standard"
-    }
-  },
-  "config": {
-    "cliConfiguration": {
-      "errors": {
-        "noConfigLoaded": "No config loaded."
-      },
-      "load": {
-        "configFromEnv": "Loaded config from environment variables for {{ accountId }}",
-        "configFromFile": "Loaded config from configuration file.",
-        "empty": "The config file was empty. Initializing an empty config."
-      },
-      "validate": {
-        "noConfig": "Valiation failed: No config was found.",
-        "noConfigAccounts": "Valiation failed: config.accounts[] is not defined.",
-        "emptyAccountConfig": "Valiation failed: config.accounts[] has an empty entry.",
-        "noAccountId": "Valiation failed: config.accounts[] has an entry missing accountId.",
-        "duplicateAccountIds": "Valiation failed: config.accounts[] has multiple entries with {{ accountId }}.",
-        "duplicateAccountNames": "Valiation failed: config.accounts[] has multiple entries with {{ accountName }}.",
-        "nameContainsSpaces": "Valiation failed: config.name {{ accountName }} cannot contain spaces."
-      },
-      "updateAccount": {
-        "noConfigToUpdate": "No config to update.",
-        "updating": "Updating account config for {{ accountId }}",
-        "addingConfigEntry": "Adding account config entry for {{ accountId }}",
-        "errors": {
-          "accountIdRequired": "An accountId is required to update the config"
-        }
-      },
-      "updateDefaultAccount": {
-        "errors": {
-          "invalidInput": "A 'defaultAccount' with value of number or string is required to update the config."
-        }
-      },
-      "renameAccount": {
-        "errors": {
-          "invalidName": "Cannot find account with identifier {{ currentName }}"
-        }
-      },
-      "removeAccountFromConfig": {
-        "deleting": "Deleting config for {{ accountId }}",
-        "errors": {
-          "invalidId": "Unable to find account for {{ nameOrId }}."
-        }
-      },
-      "updateDefaultMode": {
-        "errors": {
-          "invalidMode": "The mode {{ defaultMode }} is invalid. Valid values are {{ validModes }}."
-        }
-      },
-      "updateHttpTimeout": {
-        "errors": {
-          "invalidTimeout": "The value {{ timeout }} is invalid. The value must be a number greater than {{ minTimeout }}."
-        }
-      },
-      "updateAllowUsageTracking": {
-        "errors": {
-          "invalidInput": "Unable to update allowUsageTracking. The value {{ isEnabled }} is invalid. The value must be a boolean."
-        }
-      }
-    },
-    "configFile": {
-      "errorReading": "Config file could not be read: {{ configPath }}",
-      "writeSuccess": "Successfully wrote updated config data to {{ configPath }}",
-      "errorLoading": "A configuration file could not be found at {{ configPath }}.",
-      "errors": {
-        "parsing": "Config file could not be parsed"
-      }
-    },
-    "configUtils": {
-      "unknownType": "Unknown auth type {{ type }}"
-    },
-    "environment": {
-      "loadConfig": {
-        "missingAccountId": "Unable to load config from environment variables: Missing accountId",
-        "missingEnv": "Unable to load config from environment variables: Missing env",
-        "unknownAuthType": "Unable to load config from environment variables: Unknown auth type"
-      }
-    }
-  },
-  "models": {
-    "OAuth2Manager": {
-      "fetchingAccessToken": "Fetching access token for accountId {{ accountId }} for clientId {{ clientId }}",
-      "updatingTokenInfo": "Persisting updated tokenInfo for accountId {{ accountId }} for clientId {{ clientId }}",
-      "refreshingAccessToken": "Waiting for access token for accountId {{ accountId }}  for clientId {{ clientId }} to be fetched",
-      "errors": {
-        "missingRefreshToken": "The account {{ accountId }} has not been authenticated with Oauth2",
-        "auth": "Error while retrieving new token: {{ token }}"
-      }
-    }
-  },
-  "utils": {
-    "notify": {
-      "errors": {
-        "filePath": "Unable to notify file '{{ filePath }}'"
-      }
-    },
-    "cms": {
-      "modules": {
-        "throwInvalidPathInput": "Expected Path Input"
-      }
-    },
-    "detectPort": {
-      "errors": {
-        "invalidPort": "Port must be between {{ minPort }} and {{ maxPort }}"
-      }
-    },
-    "PortManagerServer": {
-      "started": "PortManagerServer running on port {{ port }}",
-      "setPort": "Server with instanceId {{ instanceId }} assigned to port {{ port }}",
-      "deletedPort": "Server with instanceId {{ instanceId }} unassigned from port {{ port }}",
-      "close": "PortManagerServer shutting down.",
-      "errors": {
-        "portInUse": "Failed to start PortManagerServer. Port {{ port }} is already in use.",
-        "duplicateInstance": "Failed to start PortManagerServer. An instance of PortManagerServer is already running.",
-        "404": "Could not find a server with instanceId {{ instanceId }}",
-        "409": "Failed to assign port. Server with instanceId {{ instanceId }} is already running on port {{ port }}",
-        "400": "Invalid port requested. Port must be between {{ minPort }} and {{ maxPort }}."
-      }
-    }
-  },
-  "http": {
-    "index": {
-      "createGetRequestStream": {
-        "onWrite": "Wrote file {{ filepath }}"
-      },
-      "errors": {
-        "withOauth": "Oauth manager for account {{ accountId }} not found.",
-        "withAuth": "Account with id {{ accountId }} not found."
-      }
-    }
-  },
-  "errors": {
-    "fileSystemErrors": {
-      "readAction": "reading from",
-      "writeAction": "writing to",
-      "otherAction": "accessing",
-      "unknownFilepath": "a file or folder",
-      "baseMessage": "An error occurred while {{ fileAction }} {{ filepath }}."
-    },
-    "apiErrors": {
-      "messageDetail": "{{ requestName }} in account {{ accountId }}",
-      "genericMessageDetail": "request",
-      "unableToUpload": "Unable to upload \"{{ payload }}.",
-      "codes": {
-        "400": "The {{ messageDetail }} was bad.",
-        "401": "The {{ messageDetail }} was unauthorized.",
-        "403": "The {{ messageDetail }} was forbidden.",
-        "404": "The {{ messageDetail }} was not found.",
-        "429": "The {{ messageDetail }} surpassed the rate limit. Retry in one minute.",
-        "503": "The {{ messageDetail }} could not be handled at this time. Please try again or visit https://help.hubspot.com/ to submit a ticket or contact HubSpot Support if the issue persists.",
-        "500Generic": "The {{ messageDetail }} failed due to a server error. Please try again or visit https://help.hubspot.com/ to submit a ticket or contact HubSpot Support if the issue persists.",
-        "400Generic": "The {{ messageDetail }} failed due to a client error.",
-        "generic": "The {{ messageDetail }} failed."
-      }
-    }
-  }
-}