@salesforce/plugin-auth 2.4.2 → 2.5.0

package/package.json

@@ -1,35 +1,35 @@
 {
     "name": "@salesforce/plugin-auth",
     "description": "plugin for sfdx auth commands",
-    "version": "2.4.2",
+    "version": "2.5.0",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "main": "lib/index.js",
     "dependencies": {
         "@oclif/core": "^2.0.7",
-        "@salesforce/command": "^5.2.43",
-        "@salesforce/core": "^3.32.12",
-        "@salesforce/kit": "^1.8.2",
+        "@salesforce/core": "^3.33.1",
+        "@salesforce/kit": "^1.8.3",
+        "@salesforce/sf-plugins-core": "^2.1.0",
         "chalk": "^4.1.2",
         "fs-extra": "^10.0.1",
         "open": "^8.2.1",
         "tslib": "^2"
     },
     "devDependencies": {
-        "@oclif/plugin-command-snapshot": "^3.2.16",
-        "@salesforce/cli-plugins-testkit": "^3.2.20",
+        "@oclif/plugin-command-snapshot": "^3.3.1",
+        "@salesforce/cli-plugins-testkit": "^3.2.18",
         "@salesforce/dev-config": "^3.1.0",
-        "@salesforce/dev-scripts": "^3.1.0",
+        "@salesforce/dev-scripts": "^3.1.1",
         "@salesforce/plugin-command-reference": "^2",
         "@salesforce/plugin-config": "^1.4.23",
         "@salesforce/prettier-config": "^0.0.2",
         "@salesforce/ts-sinon": "^1.4.4",
         "@swc/core": "^1.3.32",
         "@types/fs-extra": "^9.0.13",
-        "@types/graceful-fs": "^4.1.5",
+        "@types/graceful-fs": "^4.1.6",
         "@types/mkdirp": "^1.0.1",
-        "@typescript-eslint/eslint-plugin": "^5.45.0",
-        "@typescript-eslint/parser": "^5.47.1",
+        "@typescript-eslint/eslint-plugin": "^5.49.0",
+        "@typescript-eslint/parser": "^5.49.0",
         "chai": "^4.3.7",
         "eslint": "^8.33.0",
         "eslint-config-prettier": "^8.6.0",
@@ -38,7 +38,8 @@
         "eslint-config-salesforce-typescript": "^1.1.1",
         "eslint-plugin-header": "^3.0.0",
         "eslint-plugin-import": "2.27.5",
-        "eslint-plugin-jsdoc": "^39.6.7",
+        "eslint-plugin-jsdoc": "^39.6.9",
+        "eslint-plugin-sf-plugin": "^1.7.0",
         "husky": "^7.0.4",
         "mocha": "^9.1.3",
         "nyc": "^15.1.0",
@@ -114,7 +115,7 @@
         "format": "sf-format",
         "lint": "sf-lint",
         "postpack": "shx rm -f oclif.manifest.json",
-        "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:command-reference",
+        "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:json-schema && yarn test:command-reference",
         "prepack": "sf-prepack",
         "prepare": "sf-install",
         "pretest": "sf-compile-test",
@@ -122,6 +123,7 @@
         "test": "sf-test",
         "test:command-reference": "./bin/dev commandreference:generate --erroronwarnings",
         "test:deprecation-policy": "./bin/dev snapshot:compare",
+        "test:json-schema": "./bin/dev schema:compare",
         "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
         "version": "oclif readme"
     },
@@ -129,7 +131,7 @@
         "access": "public"
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/2.4.2.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/2.4.2.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/2.5.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/2.5.0.sig"
     }
 }

package/lib/prompts.d.ts

@@ -1,11 +0,0 @@
-import { UX } from '@salesforce/command';
-export declare class Prompts {
-    static shouldExitCommand(ux: UX, noPrompt?: boolean, message?: string): Promise<boolean>;
-    static shouldRunCommand(ux: UX, noPrompt?: boolean, message?: string): Promise<boolean>;
-    static askForClientSecret(ux: UX, disableMasking?: boolean): Promise<string>;
-    static askForAccessToken(ux: UX, disableMasking?: boolean): Promise<string>;
-    static askOverwriteAuthFile(ux: UX, username: string): Promise<boolean>;
-    private static askForHiddenResponse;
-    private static answeredYes;
-    private static answeredNo;
-}

package/lib/prompts.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Prompts = void 0;
-/*
- * Copyright (c) 2020, salesforce.com, inc.
- * All rights reserved.
- * Licensed under the BSD 3-Clause license.
- * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
- */
-const core_1 = require("@salesforce/core");
-const chalk = require("chalk");
-core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/plugin-auth', 'messages');
-function dimMessage(message) {
-    return chalk.dim(message);
-}
-class Prompts {
-    static async shouldExitCommand(ux, noPrompt, message) {
-        if (noPrompt || core_1.Global.getEnvironmentMode() !== core_1.Mode.DEMO) {
-            return false;
-        }
-        else {
-            const msg = dimMessage(message || messages.getMessage('warnAuth'));
-            const answer = await ux.prompt(msg);
-            return Prompts.answeredNo(answer);
-        }
-    }
-    static async shouldRunCommand(ux, noPrompt, message) {
-        if (noPrompt || core_1.Global.getEnvironmentMode() === core_1.Mode.DEMO) {
-            return true;
-        }
-        else {
-            const msg = dimMessage(message || messages.getMessage('warnAuth'));
-            const answer = await ux.prompt(msg);
-            return Prompts.answeredYes(answer);
-        }
-    }
-    static async askForClientSecret(ux, disableMasking = false) {
-        return Prompts.askForHiddenResponse(ux, 'clientSecretStdin', disableMasking);
-    }
-    static async askForAccessToken(ux, disableMasking = false) {
-        return Prompts.askForHiddenResponse(ux, 'accessTokenStdin', disableMasking);
-    }
-    static async askOverwriteAuthFile(ux, username) {
-        const yN = await ux.prompt(messages.getMessage('overwriteAccessTokenAuthUserFile', [username]), {
-            type: 'normal',
-            default: 'y',
-        });
-        return Prompts.answeredYes(yN);
-    }
-    static async askForHiddenResponse(ux, messageKey, disableMasking = false) {
-        const msg = dimMessage(messages.getMessage(messageKey));
-        return ux.prompt(msg, {
-            type: disableMasking ? 'normal' : 'hide',
-        });
-    }
-    static answeredYes(answer) {
-        return ['YES', 'Y'].includes(answer.toUpperCase());
-    }
-    static answeredNo(answer) {
-        return !['YES', 'Y'].includes(answer.toUpperCase());
-    }
-}
-exports.Prompts = Prompts;
-//# sourceMappingURL=prompts.js.map

package/lib/prompts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"prompts.js","sourceRoot":"","sources":["../src/prompts.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,2CAA0D;AAE1D,+BAA+B;AAE/B,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,yBAAyB,EAAE,UAAU,CAAC,CAAC;AAE9E,SAAS,UAAU,CAAC,OAAe;IACjC,OAAO,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED,MAAa,OAAO;IACX,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAM,EAAE,QAAkB,EAAE,OAAgB;QAChF,IAAI,QAAQ,IAAI,aAAM,CAAC,kBAAkB,EAAE,KAAK,WAAI,CAAC,IAAI,EAAE;YACzD,OAAO,KAAK,CAAC;SACd;aAAM;YACL,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,IAAI,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;YACnE,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACpC,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SACnC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAM,EAAE,QAAkB,EAAE,OAAgB;QAC/E,IAAI,QAAQ,IAAI,aAAM,CAAC,kBAAkB,EAAE,KAAK,WAAI,CAAC,IAAI,EAAE;YACzD,OAAO,IAAI,CAAC;SACb;aAAM;YACL,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,IAAI,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;YACnE,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACpC,OAAO,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAM,EAAE,cAAc,GAAG,KAAK;QACnE,OAAO,OAAO,CAAC,oBAAoB,CAAC,EAAE,EAAE,mBAAmB,EAAE,cAAc,CAAC,CAAC;IAC/E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAM,EAAE,cAAc,GAAG,KAAK;QAClE,OAAO,OAAO,CAAC,oBAAoB,CAAC,EAAE,EAAE,kBAAkB,EAAE,cAAc,CAAC,CAAC;IAC9E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAM,EAAE,QAAgB;QAC/D,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,kCAAkC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE;YAC9F,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,GAAG;SACb,CAAC,CAAC;QACH,OAAO,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IACO,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAM,EAAE,UAAkB,EAAE,cAAc,GAAG,KAAK;QAC1F,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;QACxD,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE;YACpB,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM;SACzC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,MAAc;QACvC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IACrD,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,MAAc;QACtC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAlDD,0BAkDC"}

package/messages/accesstoken.store.json

@@ -1,9 +0,0 @@
-{
-  "description": "authorize an org using an existing Salesforce access token\nBy default, the command runs interactively and asks you for the access token. If you previously authorized the org, the command prompts whether you want to overwrite the local file. Specify --noprompt to not be prompted.\nTo use the command in a CI/CD script, set the SFDX_ACCESS_TOKEN environment variable to the access token. Then run the command with the --noprompt parameter.",
-  "examples": [
-    "$ sfdx auth:accesstoken:store --instanceurl https://mycompany.my.salesforce.com",
-    "$ export SFDX_ACCESS_TOKEN=00Dxx0000000000!xxxxx",
-    "$ sfdx auth:accesstoken:store --instanceurl https://dev-hub.my.salesforce.com --noprompt"
-  ],
-  "invalidAccessTokenFormat": "The access token isn't in the correct format.\nIt should follow this pattern: %s."
-}

package/messages/device.login.json

@@ -1,11 +0,0 @@
-{
-  "description": "authorize an org using a device code\nYou must open a browser, navigate to the verification URL, and enter the code. Log in, if not already logged in, and you’ll be prompted to allow the device to connect to the org.",
-  "examples": [
-    "$ sfdx auth:device:login -d -a TestOrg1",
-    "$ sfdx auth:device:login -i <OAuth client id>",
-    "$ sfdx auth:device:login -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com"
-  ],
-  "actionRequired": "Action Required!",
-  "enterCode": "Enter %s user code in the verification URL %s",
-  "success": "Login successful for %s. You can now close the browser."
-}

package/messages/jwt.grant.json

@@ -1,11 +0,0 @@
-{
-  "description": "authorize an org using the JWT flow\nUse a certificate associated with your private key that has been uploaded to a personal connected app.\nIf you specify an --instanceurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To specify a sandbox, set --instanceurl to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.",
-  "examples": [
-    "$ sfdx auth:jwt:grant -u me@my.org -f <path to jwt key file> -i <OAuth client id>",
-    "$ sfdx auth:jwt:grant -u me@my.org -f <path to jwt key file> -i <OAuth client id> -s -a MyDefaultOrg",
-    "$ sfdx auth:jwt:grant -u me@acme.org -f <path to jwt key file> -i <OAuth client id> -r https://acme.my.salesforce.com"
-  ],
-  "username": "authentication username",
-  "key": "path to a file containing the private key",
-  "JwtGrantError": "We encountered a JSON web token error, which is likely not an issue with Salesforce CLI. Here’s the error: %s"
-}

package/messages/list.json

@@ -1,4 +0,0 @@
-{
-  "description": "list auth connection information",
-  "noResultsFound": "No results found"
-}

package/messages/logout.json

@@ -1,9 +0,0 @@
-{
-  "description": "log out from authorized orgs\nBy default, this command logs you out from your default scratch org.",
-  "examples": ["$ sfdx auth:logout -u me@my.org", "$ sfdx auth:logout -a", "$ sfdx auth:logout -p"],
-  "all": "include all authenticated orgs",
-  "allLong": "Includes all authenticated orgs: for example, Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.",
-  "logoutCommandYesNo": "Are you sure you want to log out from these org(s)?\n%s\n\nImportant: You need a password to reauthorize scratch orgs. By default, scratch orgs have no password. If you still need your scratch orgs, run \"sfdx force:user:password:generate\" before logging out. If you don't need the scratch orgs anymore, run \"sfdx force:org:delete\" instead of logging out.\n\nLog out (y/n)?",
-  "specifiedBothUserAndAllError": "Specify either --targetusername or --all.",
-  "logoutOrgCommandSuccess": "Successfully logged out of orgs: %s"
-}

package/messages/messages.json

@@ -1,37 +0,0 @@
-{
-  "HelpDefaults": "If not supplied, the apiversion, template, and outputdir use default values.\n",
-  "HelpOutputDirRelative": "The outputdir can be an absolute path or relative to the current working directory.\n",
-  "HelpOutputDirRelativeLightning": "If you don’t specify an outputdir, we create a subfolder in your current working directory with the name of your bundle. For example, if the current working directory is force-app and your Lightning bundle is called myBundle, we create force-app/myBundle/ to store the files in the bundle.\n",
-  "HelpExamplesTitle": "\nExamples:\n",
-  "OutputDirFlagDescription": "folder for saving the created files",
-  "OutputDirFlagLongDescription": "The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The default is the current directory.",
-  "TemplateFlagDescription": "template to use for file creation",
-  "TemplateFlagLongDescription": "The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.",
-  "TargetDirOutput": "target dir = %s",
-  "App": "app",
-  "Event": "event",
-  "Interface": "interface",
-  "Test": "test",
-  "Component": "component",
-  "Page": "page",
-  "AlphaNumericNameError": "Name must contain only alphanumeric characters.",
-  "NameMustStartWithLetterError": "Name must start with a letter.",
-  "EndWithUnderscoreError": "Name can't end with an underscore.",
-  "DoubleUnderscoreError": "Name can't contain 2 consecutive underscores.",
-  "clientId": "OAuth client ID (sometimes called the consumer key)",
-  "setDefaultDevHub": "set the authenticated org as the default dev hub org for scratch org creation",
-  "setDefaultUsername": "set the authenticated org as the default username that all commands run against",
-  "setAlias": "set an alias for the authenticated org",
-  "instanceUrl": "the login URL of the instance the org lives on",
-  "authorizeCommandSuccess": "Successfully authorized %s with org ID %s",
-  "authorizeCommandCloseBrowser": "You may now close the browser",
-  "warnAuth": "Logging in to a business or production org is not recommended on a demo or shared machine. Please run \"sfdx auth:logout --targetusername <your username> --noprompt\" when finished using this org, which is similar to logging out of the org in the browser.\n\nDo you want to authorize this org for use with the Salesforce CLI (y/n)?",
-  "noPromptAuth": "do not prompt for auth confirmation in demo mode",
-  "disableMasking": "disable masking of user input (for use with problematic terminals)",
-  "clientSecretStdin": "OAuth client secret of personal connected app?",
-  "invalidInstanceUrl": "Invalid instance URL. Specify a Salesforce instance URL using the format <domainname>.salesforce.com",
-  "accessTokenStdin": "Access token of user to use for authentication",
-  "noPrompt": "do not prompt for confirmation",
-  "overwriteAuthFileYesNo": "An authorization file exists for user \"%s\". Are you sure you want to save the file?\n\nSave the user (y/n)?",
-  "overwriteAccessTokenAuthUserFile": "A file already exists for user \"%s\", which is associated with the access token you provided.\nAre you sure you want to overwrite the existing file? (y/n)?"
-}

package/messages/sfdxurl.store.json

@@ -1,8 +0,0 @@
-{
-  "description": "authorize an org using an SFDX auth URL stored within a file\nThe SFDX auth URL must have the format \"%s\". NOTE: The SFDX auth URL uses the \"force\" protocol, and not \"http\" or \"https\". Also, the \"instanceUrl\" inside the SFDX auth URL doesn't include the protocol (\"https://\").\n\nYou have three options when creating the auth file. The easiest option is to redirect the output of the `sfdx force:org:display --verbose --json` command into a file. For example, using an org you have already authorized:\n\n    $ sfdx force:org:display -u <OrgUsername> --verbose --json > authFile.json\n    $ sfdx auth:sfdxurl:store -f authFile.json\n\nThe resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object. NOTE: The `force:org:display --verbose` command displays the refresh token only for orgs authorized with the web server flow, and not the JWT bearer flow. \n\nYou can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the auth URL. Finally, you can create a normal text file that includes just the URL and nothing else.",  
-  "file": "path to a file containing the sfdx url",
-  "examples": [
-    "$ sfdx auth:sfdxurl:store -f <path to sfdxAuthUrl file>",
-    "$ sfdx auth:sfdxurl:store -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg"
-  ]
-}

package/messages/web.login.json

@@ -1,12 +0,0 @@
-{
-  "description": "authorize an org using the web login flow\nIf you specify an --instanceurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To log in to a sandbox, set --instanceurl to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.\nTo open in a specific browser, use the --browser parameter. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
-  "examples": [
-    "$ sfdx auth:web:login -a TestOrg1",
-    "$ sfdx auth:web:login -i <OAuth client id>",
-    "$ sfdx auth:web:login -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com",
-    "$ sfdx auth:web:login -a TestOrg1 -b firefox"
-  ],
-  "browser": "browser where the org opens",
-  "deviceWarning": "auth:web:login doesn't work when authorizing to a headless environment. Use auth:device:login instead.",
-  "invalidClientId": "Invalid client credentials. Verify the OAuth client secret and ID. %s"
-}