@salesforce/core 7.3.10 → 7.3.12-qa.0

package/lib/org/authInfo.js

@@ -52,6 +52,7 @@ const stateAggregator_1 = require("../stateAggregator/stateAggregator");
 const filters_1 = require("../logger/filters");
 const messages_1 = require("../messages");
 const sfdcUrl_1 = require("../util/sfdcUrl");
+const findSuggestion_1 = require("../util/findSuggestion");
 const connection_1 = require("./connection");
 const orgConfigProperties_1 = require("./orgConfigProperties");
 const org_1 = require("./org");
@@ -624,7 +625,17 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         }
         // If a username with NO oauth options, ensure authorization already exist.
         else if (username && !authOptions && !(await this.stateAggregator.orgs.exists(username))) {
-            throw messages.createError('namedOrgNotFound', [username]);
+            const likeName = (0, findSuggestion_1.findSuggestion)(username, [
+                ...(await this.stateAggregator.orgs.list()).map((f) => f.split('.json')[0]),
+                ...Object.keys(this.stateAggregator.aliases.getAll()),
+            ]);
+            throw sfError_1.SfError.create({
+                name: 'NamedOrgNotFoundError',
+                message: messages.getMessage('namedOrgNotFound', [username]),
+                actions: likeName === ''
+                    ? undefined
+                    : [`It looks like you mistyped the username or alias. Did you mean "${likeName}"?`],
+            });
         }
         else {
             await this.initAuthOptions(authOptions);

package/lib/org/scratchOrgInfoGenerator.js

@@ -53,6 +53,7 @@ const getAncestorIds = async (scratchOrgInfo, projectJson, hubOrg) => {
         throw new sfError_1.SfError(messages.getMessage('Package2AncestorsIdsKeyNotSupportedError'), 'DeprecationError');
     }
     const packagesWithAncestors = (await projectJson.getPackageDirectories())
+        .filter(sfProject_1.isPackagingDirectory)
         // check that the package has any ancestor types (id or version)
         .filter((packageDir) => packageDir.ancestorId ?? packageDir.ancestorVersion);
     if (packagesWithAncestors.length === 0) {

package/lib/sfProject.d.ts

@@ -1,40 +1,9 @@
 import { Dictionary, JsonMap, Nullable, Optional } from '@salesforce/ts-types';
+import { PackageDir as PackageDirSchema, PackageDirDependency as PackageDirDependencySchema, ProjectJson as ProjectJsonSchema, PackagePackageDir } from '@salesforce/schemas';
 import { ConfigFile } from './config/configFile';
 import { ConfigContents } from './config/configStackTypes';
-export type PackageDirDependency = {
-    [k: string]: unknown;
-    package: string;
-    versionNumber?: string;
-};
-export type PackageDir = {
-    ancestorId?: string;
-    ancestorVersion?: string;
-    default?: boolean;
-    definitionFile?: string;
-    dependencies?: PackageDirDependency[];
-    includeProfileUserLicenses?: boolean;
-    package?: string;
-    packageMetadataAccess?: {
-        permissionSets: string | string[];
-        permissionSetLicenses: string | string[];
-    };
-    path: string;
-    postInstallScript?: string;
-    postInstallUrl?: string;
-    releaseNotesUrl?: string;
-    scopeProfiles?: boolean;
-    uninstallScript?: string;
-    versionDescription?: string;
-    versionName?: string;
-    versionNumber?: string;
-    unpackagedMetadata?: {
-        path: string;
-    };
-    seedMetadata?: {
-        path: string;
-    };
-};
-export type NamedPackageDir = PackageDir & {
+export type PackageDirDependency = PackageDirDependencySchema;
+type NamedDirAdditions = {
     /**
      * The [normalized](https://nodejs.org/api/path.html#path_path_normalize_path) path used as the package name.
      */
@@ -44,20 +13,10 @@ export type NamedPackageDir = PackageDir & {
      */
     fullPath: string;
 };
-export type ProjectJson = ConfigContents & {
-    packageDirectories: PackageDir[];
-    namespace?: string;
-    sourceApiVersion?: string;
-    sfdcLoginUrl?: string;
-    signupTargetLoginUrl?: string;
-    oauthLocalPort?: number;
-    plugins?: {
-        [k: string]: unknown;
-    };
-    packageAliases?: {
-        [k: string]: string;
-    };
-};
+export type PackageDir = PackageDirSchema;
+export type NamedPackagingDir = PackagePackageDir & NamedDirAdditions;
+export type NamedPackageDir = PackageDir & NamedDirAdditions;
+export type ProjectJson = ConfigContents & ProjectJsonSchema;
 /**
  * The sfdx-project.json config object. This file determines if a folder is a valid sfdx project.
  *
@@ -358,3 +317,7 @@ export declare class SfProject {
     getPackageIdFromAlias(alias: string): Optional<string>;
     getAliasesFromPackageId(id: string): string[];
 }
+/** differentiate between the Base PackageDir (path, maybe default) and the Packaging version (package and maybe a LOT of other fields) by whether is has the `package` property */
+export declare const isPackagingDirectory: (packageDir: PackageDir) => packageDir is PackagePackageDir;
+export declare const isNamedPackagingDirectory: (packageDir: NamedPackageDir) => packageDir is NamedPackagingDir;
+export {};

package/lib/sfProject.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SfProject = exports.SfProjectJson = void 0;
+exports.isNamedPackagingDirectory = exports.isPackagingDirectory = exports.SfProject = exports.SfProjectJson = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -282,16 +282,7 @@ class SfProjectJson extends configFile_1.ConfigFile {
      * @param packageDir
      */
     addPackageDirectory(packageDir) {
-        // there is no notion of uniqueness in package directory entries
-        // so an attempt of matching an existing entry is a bit convoluted
-        // an entry w/o a package or id is considered a directory entry for which a package has yet to be created
-        // so first attempt is to find a matching dir entry that where path is the same and id and package are not present
-        // if that fails, then find a matching dir entry package is present and is same as the new entry
-        const dirIndex = this.getContents().packageDirectories.findIndex((pd) => {
-            const withId = pd;
-            return ((withId.path === packageDir.path && !withId.id && !withId.package) ||
-                (!!packageDir.package && packageDir.package === withId.package));
-        });
+        const dirIndex = this.getContents().packageDirectories.findIndex(findPackageDir(packageDir));
         // merge new package dir with existing entry, if present
         const packageDirEntry = Object.assign({}, dirIndex > -1 ? this.getContents().packageDirectories[dirIndex] : packageDir, packageDir);
         const modifiedPackagesDirs = dirIndex > -1
@@ -301,6 +292,7 @@ class SfProjectJson extends configFile_1.ConfigFile {
                 [...(this.getContents()?.packageDirectories ?? []), packageDirEntry];
         this.set('packageDirectories', modifiedPackagesDirs);
     }
+    // keep it because testSetup stubs it!
     // eslint-disable-next-line class-methods-use-this
     doesPackageExist(packagePath) {
         return fs.existsSync(packagePath);
@@ -520,7 +512,9 @@ class SfProject {
      */
     getPackageNameFromPath(path) {
         const packageDir = this.getPackageFromPath(path);
-        return packageDir ? packageDir.package ?? packageDir.path : undefined;
+        if (!packageDir)
+            return undefined;
+        return (0, exports.isNamedPackagingDirectory)(packageDir) ? packageDir.package : packageDir.path;
     }
     /**
      * Returns the package directory.
@@ -664,4 +658,19 @@ class SfProject {
     }
 }
 exports.SfProject = SfProject;
+/** differentiate between the Base PackageDir (path, maybe default) and the Packaging version (package and maybe a LOT of other fields) by whether is has the `package` property */
+const isPackagingDirectory = (packageDir) => 'package' in packageDir && typeof packageDir.package === 'string';
+exports.isPackagingDirectory = isPackagingDirectory;
+const isNamedPackagingDirectory = (packageDir) => 'package' in packageDir && typeof packageDir.package === 'string';
+exports.isNamedPackagingDirectory = isNamedPackagingDirectory;
+/**
+ * there is no notion of uniqueness in package directory entries
+ * so an attempt of matching an existing entry is a bit convoluted
+ */
+const findPackageDir = (target) => (potentialMatch) => 
+// an entry w/o a package or id is considered a directory entry for which a package has yet to be created
+//  find a matching dir entry that where path is the same and id and package are not present
+(potentialMatch.path === target.path && !('id' in potentialMatch) && !(0, exports.isPackagingDirectory)(potentialMatch)) ||
+    // if that fails, then find a matching dir entry package is present and is same as the new entry
+    ((0, exports.isPackagingDirectory)(target) && (0, exports.isPackagingDirectory)(potentialMatch) && target.package === potentialMatch.package);
 //# sourceMappingURL=sfProject.js.map

package/lib/util/findSuggestion.d.ts

@@ -0,0 +1,7 @@
+/**
+ * From the haystack, will find the closest value to the needle
+ *
+ * @param needle - what the user provided - find results similar to this
+ * @param haystack - possible results to search against
+ */
+export declare const findSuggestion: (needle: string, haystack: string[]) => string;

package/lib/util/findSuggestion.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findSuggestion = void 0;
+/*
+ * Copyright (c) 2023, 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 fast_levenshtein_1 = __importDefault(require("fast-levenshtein"));
+/**
+ * From the haystack, will find the closest value to the needle
+ *
+ * @param needle - what the user provided - find results similar to this
+ * @param haystack - possible results to search against
+ */
+const findSuggestion = (needle, haystack) => {
+    // we'll use this array to keep track of which piece of hay is the closest to the users entered value.
+    // keys closer to the index 0 will be a closer guess than keys indexed further from 0
+    // an entry at 0 would be a direct match, an entry at 1 would be a single character off, etc.
+    const index = [];
+    haystack.map((hay) => {
+        index[fast_levenshtein_1.default.get(needle, hay)] = hay;
+    });
+    return index.find((item) => item !== undefined) ?? '';
+};
+exports.findSuggestion = findSuggestion;
+//# sourceMappingURL=findSuggestion.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "7.3.10",
+  "version": "7.3.12-qa.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
@@ -53,11 +53,12 @@
   ],
   "dependencies": {
     "@jsforce/jsforce-node": "^3.2.0",
-    "@salesforce/kit": "^3.1.1",
+    "@salesforce/kit": "^3.1.2",
     "@salesforce/schemas": "^1.9.0",
     "@salesforce/ts-types": "^2.0.9",
     "ajv": "^8.15.0",
     "change-case": "^4.1.2",
+    "fast-levenshtein": "^3.0.0",
     "faye": "^1.4.0",
     "form-data": "^4.0.0",
     "js2xmlparser": "^4.0.1",
@@ -75,6 +76,7 @@
     "@salesforce/ts-sinon": "^1.4.19",
     "@types/benchmark": "^2.1.5",
     "@types/chai-string": "^1.4.5",
+    "@types/fast-levenshtein": "^0.0.4",
     "@types/jsonwebtoken": "9.0.6",
     "@types/proper-lockfile": "^4.1.4",
     "@types/semver": "^7.5.8",