@forge/cli-shared 9.10.0-next.1-experimental-1e95696 → 9.10.0-next.11

package/out/ui/text.js

@@ -29,11 +29,15 @@ const go = (link) => buildTerminalLink(`https://go.atlassian.com/${link}`);
 const gettingStartedDACLink = go('dac/platform/forge/getting-started/#log-in-with-an-atlassian-api-token');
 const command = (...args) => chalk_1.default.bold(args.join(' '));
 const forge = (...args) => command('forge', ...args);
+const autoSpaceSentences = (...sentences) => sentences
+    .filter((sentence) => sentence.length > 0)
+    .join(' ');
 function itemList(items, indent) {
     return items.map((item) => `${indent ?? ' '}- ${item}`).join(`\n${indent ?? ''}`);
 }
 const fatalError = (message) => chalk_1.default.bold(chalk_1.default.red(message));
 const approveRuleDescription = 'list of validation rules to approve';
+const keytarAccessErrorBase = (message) => `Keytar error detected: ${message}`;
 const capitalise = (word) => word.charAt(0).toUpperCase() + word.slice(1);
 exports.capitalise = capitalise;
 const getLintMessage = (line, column, message, level, colourFunction, reference) => `${chalk_1.default.dim(`${line}:${column}`.padEnd(7))} ${colourFunction(level.padEnd(8))} ${message}  ${chalk_1.default.dim(reference)}\n`;
@@ -45,6 +49,16 @@ const checkLintTotalPlurals = (numErrors, numWarnings, numApprovals, numFixableE
     pluralCheckedFixableErrors: `${numFixableErrors} ${numFixableErrors === 1 ? 'error' : 'errors'}`,
     pluralCheckedFixableWarnings: `${numFixableWarnings} ${numFixableWarnings === 1 ? 'warning' : 'warnings'}`
 });
+const platformKeytarRecommendations = () => {
+    switch (process.platform) {
+        case 'darwin':
+            return 'Ensure you enable access to the macOS keychain when prompted.';
+        case 'linux':
+            return `Ensure you have ${chalk_1.default.bold('libsecret')} installed.`;
+        default:
+            return '';
+    }
+};
 const globalTargetLocation = ({ unit, org }) => unit && org
     ? `in unit ${chalk_1.default.bold(unit)} in organization ${chalk_1.default.bold(org)}`
     : unit
@@ -54,9 +68,15 @@ exports.Text = {
     buildTerminalLink,
     go,
     error: {
-        noTokenStored: `Not logged in. Run ${forge('login')}, or set the FORGE_EMAIL and FORGE_API_TOKEN environment variables before trying again. See ${gettingStartedDACLink} for more.`,
-        credentialsFilePermissions: `The CLI couldn't securely store your login credentials in the local credentials file. ` +
-            `Set the FORGE_EMAIL and FORGE_API_TOKEN environment variables instead. See ${gettingStartedDACLink} for more.`,
+        noKeytar: autoSpaceSentences(`The CLI couldn't securely store your login credentials in a local keychain.`, platformKeytarRecommendations(), `If a local keychain is not available, use environment variables before trying again. See ${gettingStartedDACLink} for more.`),
+        noTokenStored: `Not logged in. If a local keychain is available, run ${forge('login')}, otherwise set environment variables before trying again. See ${gettingStartedDACLink} for more.`,
+        keytarAccessError: {
+            other: (message) => keytarAccessErrorBase(message),
+            mac: (message) => keytarAccessErrorBase(message) +
+                `\nSomething went wrong while accessing Keychain Access. Try locking and unlocking the login keychain.`,
+            linux: (message) => keytarAccessErrorBase(message) + `\nSomething went wrong while accessing Secret Service API.`,
+            windows: (message) => keytarAccessErrorBase(message) + `\nSomething went wrong while accessing Credentials Vault.`
+        },
         outdatedCLIVersion: (installed, latest) => `Warning: Your version of Forge CLI is out of date. We recommend you update to the latest version to get the latest features and bug fixes.` +
             `\nRun ${command('npm', 'install', '-g', `${cli_details_1.FORGE_CLI_PACKAGE}@latest`)} to update from version ${chalk_1.default.bold(installed)} to ${chalk_1.default.bold(latest)}.` +
             `\n`,
@@ -69,7 +89,7 @@ exports.Text = {
         invalidSite: 'The site you entered is not an Atlassian site. Rerun the command with the URL to an Atlassian site to install the app.',
         invalidWorkspace: 'The workspace you entered is not a valid workspace. Rerun the command with the URL to a valid workspace to install the app.',
         invalidInstallationContext: 'Could not find an installation for the provided Atlassian app',
-        invalidTokenInCredentialFile: `Your API token is no longer valid. Run ${forge('login')} to reset your login credentials.`,
+        invalidTokenInKeytar: `Your API token is no longer valid. Run ${forge('login')} to reset your login credentials.`,
         invalidUpgradeTarget: 'You must specify either "all" or "code" as the upgrade target.',
         invalidTokenInEnv: (instructionsUrl, emailVar, tokenVar) => `The API token on your machine is no longer valid.` +
             `\n    1) Get a new API token: ${instructionsUrl}` +
@@ -102,6 +122,9 @@ exports.Text = {
         environmentIsNotDefined: (envKey) => `Environment with name ${envKey} not defined. Create this environment with ${chalk_1.default.bold(`forge environments create -e ${envKey}`)} before proceeding.`
     },
     warning: {
+        plaintextCredentialsFound: (url) => `Your credentials were stored in plaintext by a previous version of the Forge CLI. For additional security, revoke your existing API token by visting this URL ${buildTerminalLink(url)}.`,
+        plaintextCredentialsMigrated: 'The credentials found in plaintext have been migrated to your local keychain.',
+        plaintextCredentialsNotMigrated: autoSpaceSentences(`The CLI couldn't securely store your login credentials in a local keychain.`, platformKeytarRecommendations(), `If a local keychain is not available, use environment variables instead. See ${gettingStartedDACLink} for more information.`),
         unsupportedNodeVersion: (_userNodeVersion, supportedNodeVersions) => log_color_1.LogColor.warn(`Warning: Forge CLI supports Node.js ${supportedNodeVersions}.` +
             `\nUnsupported Node.js versions are not guaranteed to work correctly.\n`),
         deprecation: {
@@ -218,7 +241,7 @@ exports.Text = {
         },
         error: {
             personalCredentialsEnv: (emailKey, apiTokenKey) => `We couldn't get your Atlassian account information. Check the ${emailKey} and ${apiTokenKey} environment variables.`,
-            personalCredentialsFile: `We couldn't get your Atlassian account information. You may need to run ${forge('login')} to log in again.`
+            personalCredentialsKeytar: `We couldn't get your Atlassian account information. You may need to run ${forge('login')} to log in again.`
         }
     },
     feedback: {
@@ -254,8 +277,8 @@ What do you like or don't like about Forge? Share your feedback below or press C
         introWithCurrentDirectory: (currentDirectory) => `Creating an app in your current directory:\n\n    ${chalk_1.default.bold(currentDirectory)}\n`,
         optionTemplate: 'specify the template to use',
         optionDirectory: 'specify the directory to create (uses the template name by default)',
-        optionSpace: 'specify the Developer Space id to use',
-        optionAcceptTerms: 'automatically accept terms and conditions in non-interactive mode',
+        optionSpace: `specify the Developer Space id to use (see your Developer Spaces by running ${forge('developer-spaces', 'list')})`,
+        optionAcceptTerms: 'accept terms and conditions without prompting',
         optionPersonal: 'register as a personal app',
         overviewAppName: `\nName your app. The app name can include dashes, spaces, and underscores.\n`,
         overviewTemplates: '\nStart with a template. Each template contains the required files to be a valid app.\n',
@@ -272,6 +295,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
         taskRegister: 'Registering app',
         taskCreateEnvironments: 'Creating environments',
         taskPackages: 'Installing dependencies',
+        taskModules: 'Adding modules',
         error: {
             dirtyDirectory: 'Destination directory is not empty',
             app: {
@@ -283,12 +307,40 @@ What do you like or don't like about Forge? Share your feedback below or press C
             name: {
                 tooLong: (max) => `The app name exceeds ${max} characters. Run ${forge('create')} using a shorter app name.`
             },
+            nonInteractive: {
+                missingInputs: (missingInputs, nextCommand) => {
+                    const labelWidth = Math.max(...missingInputs.map(({ label }) => label.length));
+                    const inputs = missingInputs.map(({ label, hint }) => `${label.padEnd(labelWidth)}   ${hint}`);
+                    return `Missing required inputs for non-interactive mode.\n\nProvide:\n${itemList(inputs)}\n\nNext: ${forge('create', ...nextCommand)}`;
+                },
+                labels: {
+                    appName: '<app name>',
+                    template: '-t, --template <template name>',
+                    developerSpace: '-s, --developer-space-id <Developer Space id>',
+                    acceptTerms: '-y, --accept-terms'
+                },
+                placeholders: {
+                    appName: '<app name>',
+                    template: '<template name>',
+                    directory: '<directory name>',
+                    developerSpace: '<Developer Space id>'
+                },
+                appNameHint: (maxLength) => `up to ${maxLength} characters`,
+                templateHint: 'for example: blank',
+                developerSpaceHint: `find one with: ${forge('developer-spaces', 'list', '--json')}`,
+                acceptTermsHint: 'accepts the Developer Terms, Privacy Policy and usage pricing'
+            },
             template: {
                 download: (template) => `Failed to download the ${template} template. Run ${forge('create')} again.`,
                 notFound: (template) => `The template ${template} doesn't exist. Run ${forge('create')} using a different template.`,
                 noTemplates: 'There are no templates to choose from.',
                 unexpectedArchiveFormat: 'Unexpected template format.'
             },
+            preset: {
+                notFound: (preset) => `The preset ${preset} doesn't exist. Run ${forge('create')} using a different preset.`,
+                withTemplate: `Run ${forge('create')} with either --template or --preset, not both.`,
+                modulesFailed: `Your app was created, but some preset modules couldn't be added. Run ${forge('module add')} from the app directory to add them.`
+            },
             packages: {
                 installFail: `Something went wrong while installing app dependencies. Try running ${forge('create')} again.`
             }
@@ -442,6 +494,7 @@ What do you like or don't like about Forge? Share your feedback below or press C
     defaultEnv: {
         info: 'You do not have a default development environment set. This is required to run commands without specifying an environment. Make sure not to use sensitive information when naming your default development environment.',
         prompt: 'Enter a name for your default development environment:',
+        notSetNonInteractive: `No environment was given and you don't have a default development environment. Pass --environment, or set a default with ${forge('settings', 'set', 'default-environment', '<environment>')}.`,
         warn: `${chalk_1.default.bold('Warning:')} A development environment with this name already exists. If you continue, you may be using the same environment as another contributor.`,
         confirm: 'Do you want to continue?',
         setSuccess: (envKey, envType) => `${exports.Text.env.displayEnvironment(envKey, envType)} has been set as your default development environment`,
@@ -1297,6 +1350,51 @@ ${buildTerminalLink(link)}\n`,
         banner: `Showing latest deployments of your app:`,
         noDeployments: `No deployments found for this app.\nRun ${forge('deploy')} to deploy your app to an environment.`
     },
+    deployStatus: {
+        cmd: 'show the placement deployment status of an app version in an environment',
+        majorVersionOption: 'specify the major version to show (defaults to the latest deployed version)',
+        banner: (envKey, envType, version) => `${log_symbols_1.default.info} Environment: ${exports.Text.env.displayEnvironment(envKey, envType)} (Version: ${version})`,
+        artifactUploaded: (createdAt, buildTag) => {
+            const buildTagText = buildTag ? ` from build with tag ${buildTag}` : '';
+            return `${log_symbols_1.default.success} App artifact uploaded${buildTagText} at ${createdAt}`;
+        },
+        overall: {
+            succeeded: (succeeded, total) => `${log_symbols_1.default.success} Deployment succeeded (${succeeded}/${total} placements)`,
+            failed: (succeeded, total) => `${log_symbols_1.default.error} Deployment failed (${succeeded}/${total} placements succeeded)`,
+            inProgress: (succeeded, total, inProgress) => `${log_symbols_1.default.info} Deployment still in progress (${succeeded}/${total} placements succeeded, ${inProgress} in progress)`
+        },
+        checkAgain: (envKey, majorVersion) => `Run ${forge('deploy status', '-e', (0, environment_1.environmentToOption)(envKey), ...(majorVersion ? ['-v', String(majorVersion)] : []))} again to check for updates.`,
+        table: {
+            placementType: 'Placement type',
+            placement: 'Placement',
+            status: 'Status',
+            failedStep: 'Failed step',
+            lastUpdated: 'Last updated'
+        },
+        placementTypeLabel: (placementType) => ({
+            [graphql_runtime_enums_1.AppPlacementType.Region]: 'Region',
+            [graphql_runtime_enums_1.AppPlacementType.CustomerDataPlane]: 'Customer data plane',
+            [graphql_runtime_enums_1.AppPlacementType.IsolationContext]: 'Isolation context'
+        })[placementType] ?? placementType,
+        groupLabel: (placementTypeLabel, succeeded, total) => `${placementTypeLabel} (${succeeded}/${total})`,
+        statusLabel: (status) => ({
+            [graphql_runtime_enums_1.AppVersionDeploymentStatus.Succeeded]: chalk_1.default.green('Succeeded'),
+            [graphql_runtime_enums_1.AppVersionDeploymentStatus.Failed]: chalk_1.default.red('Failed'),
+            [graphql_runtime_enums_1.AppVersionDeploymentStatus.InProgress]: chalk_1.default.yellow('In progress')
+        })[status] ?? status,
+        stepLabel: (step) => ({
+            [graphql_runtime_enums_1.AppVersionDeploymentStep.Artifact]: 'Artifact',
+            [graphql_runtime_enums_1.AppVersionDeploymentStep.Function]: 'Function',
+            [graphql_runtime_enums_1.AppVersionDeploymentStep.Containers]: 'Containers',
+            [graphql_runtime_enums_1.AppVersionDeploymentStep.HostedResources]: 'Hosted resources',
+            [graphql_runtime_enums_1.AppVersionDeploymentStep.CustomScopes]: 'Custom scopes',
+            [graphql_runtime_enums_1.AppVersionDeploymentStep.OauthClient]: 'OAuth client',
+            [graphql_runtime_enums_1.AppVersionDeploymentStep.ScheduledTriggers]: 'Scheduled triggers'
+        })[step] ?? step,
+        noPlacements: `No placements found for this version. Placements are added when your app is installed.\nRun ${forge('install')} to install your app.`,
+        noVersion: (envKey, envType) => `No deployed version found in the ${exports.Text.env.displayEnvironment(envKey, envType)} environment. Run ${forge('deploy')} to deploy your app first.`,
+        noStatus: (version, envKey, envType) => `No deployment status is available for version ${version} in the ${exports.Text.env.displayEnvironment(envKey, envType)} environment yet.`
+    },
     tunnel: {
         cmd: 'start a tunnel to connect your local code with the app running in the development environment',
         optionDebugger: 'enable debugger mode',
@@ -1696,6 +1794,10 @@ ${buildTerminalLink(link)}\n`,
             description: 'Change your default development environment',
             info: `To view all environments for this app, run ${forge('environments', 'list')}.`
         },
+        nonInteractive: {
+            description: 'Run commands without prompts: auto (when an agent runs the command, not in CI), on, or off. FORGE_NON_INTERACTIVE overrides it',
+            invalidValue: 'Invalid value specified. Valid values: auto, on, off'
+        },
         customEffects: {
             description: 'Enable custom spinner effects',
             setupError: chalk_1.default.yellow('Failed to fetch custom spinner config. Custom spinner effects can be disabled via forge settings')
@@ -1769,7 +1871,10 @@ When errors occur during Forge command execution, error details will be sent to
         description: 'run the command without input prompts',
         error: {
             missingRequiredOption: (command, requiredOptions) => `${command} --non-interactive requires ${requiredOptions.join(' ')}`,
-            missingAnalyticsPreferences: `--non-interactive requires an analytics setting. Use ${forge('settings', 'set', 'usage-analytics', '<value>')}.`
+            missingAnalyticsPreferences: `--non-interactive requires an analytics setting. Use ${forge('settings', 'set', 'usage-analytics', '<value>')}.`,
+            promptReached: (question) => `${question ? `"${question.trim()}" needs an answer, but` : 'This command needs input, but'} the CLI is ` +
+                `running in non-interactive mode, so it can't ask. Pass the answer as an option. Run the command with ` +
+                `--help to see its options.`
         }
     },
     customScopes: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cli-shared",
-  "version": "9.10.0-next.1-experimental-1e95696",
+  "version": "9.10.0-next.11",
   "description": "Common functionality for Forge CLI",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -13,8 +13,8 @@
     "prebuild": "yarn generate-graphql-types"
   },
   "dependencies": {
-    "@forge/manifest": "13.8.1-next.0-experimental-1e95696",
-    "@forge/util": "3.1.0-next.0-experimental-1e95696",
+    "@forge/manifest": "13.9.0-next.5",
+    "@forge/util": "4.0.0-next.2",
     "@forge/i18n": "1.0.1",
     "@sentry/node": "7.106.0",
     "@vercel/detect-agent": "^1.2.5",
@@ -39,6 +39,7 @@
     "inquirer": "^8.2.6",
     "inquirer-autocomplete-prompt": "^2.0.1",
     "io-ts": "^2.2.22",
+    "keytar": "^7.9.0",
     "ora": "^5.4.1",
     "recursive-readdir": "^2.2.3",
     "semver": "^7.6.0",