@salesforce/core 7.3.12-qa.1 → 7.4.0

package/lib/lifecycleEvents.d.ts

@@ -1,5 +1,7 @@
 import { AnyJson } from '@salesforce/ts-types';
-type callback = (data: any) => Promise<void>;
+export type callback = (data: any) => Promise<void>;
+type ListenerMap = Map<string, callback>;
+export type UniqueListenerMap = Map<string, ListenerMap>;
 /**
  * An asynchronous event listener and emitter that follows the singleton pattern. The singleton pattern allows lifecycle
  * events to be emitted from deep within a library and still be consumed by any other library or tool. It allows other
@@ -92,4 +94,5 @@ export declare class Lifecycle {
      */
     emit<T = AnyJson>(eventName: string, data: T): Promise<void>;
 }
+export declare const cloneUniqueListeners: (uniqueListeners: UniqueListenerMap) => UniqueListenerMap;
 export {};

package/lib/lifecycleEvents.js

@@ -29,7 +29,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Lifecycle = void 0;
+exports.cloneUniqueListeners = exports.Lifecycle = void 0;
 const semver_1 = require("semver");
 // needed for TS to not put everything inside /lib/src
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -102,8 +102,8 @@ class Lifecycle {
         (0, semver_1.compare)(global.salesforceCoreLifecycle.version(), Lifecycle.staticVersion()) === -1) {
             const oldInstance = global.salesforceCoreLifecycle;
             // use the newer version and transfer any listeners from the old version
-            // object spread keeps them from being references
-            global.salesforceCoreLifecycle = new Lifecycle({ ...oldInstance.listeners }, oldInstance.uniqueListeners);
+            // object spread and the clone fn keep them from being references
+            global.salesforceCoreLifecycle = new Lifecycle({ ...oldInstance.listeners }, (0, exports.cloneUniqueListeners)(oldInstance.uniqueListeners));
             // clean up any listeners on the old version
             Object.keys(oldInstance.listeners).map((eventName) => {
                 oldInstance.removeAllListeners(eventName);
@@ -232,4 +232,7 @@ class Lifecycle {
     }
 }
 exports.Lifecycle = Lifecycle;
+const cloneListeners = (listeners) => new Map(Array.from(listeners.entries()));
+const cloneUniqueListeners = (uniqueListeners) => new Map(Array.from(uniqueListeners.entries()).map(([key, value]) => [key, cloneListeners(value)]));
+exports.cloneUniqueListeners = cloneUniqueListeners;
 //# sourceMappingURL=lifecycleEvents.js.map

package/lib/org/scratchOrgInfoGenerator.js

@@ -53,7 +53,6 @@ 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,9 +1,40 @@
 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 = PackageDirDependencySchema;
-type NamedDirAdditions = {
+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 & {
     /**
      * The [normalized](https://nodejs.org/api/path.html#path_path_normalize_path) path used as the package name.
      */
@@ -13,10 +44,20 @@ type NamedDirAdditions = {
      */
     fullPath: string;
 };
-export type PackageDir = PackageDirSchema;
-export type NamedPackagingDir = PackagePackageDir & NamedDirAdditions;
-export type NamedPackageDir = PackageDir & NamedDirAdditions;
-export type ProjectJson = ConfigContents & ProjectJsonSchema;
+export type ProjectJson = ConfigContents & {
+    packageDirectories: PackageDir[];
+    namespace?: string;
+    sourceApiVersion?: string;
+    sfdcLoginUrl?: string;
+    signupTargetLoginUrl?: string;
+    oauthLocalPort?: number;
+    plugins?: {
+        [k: string]: unknown;
+    };
+    packageAliases?: {
+        [k: string]: string;
+    };
+};
 /**
  * The sfdx-project.json config object. This file determines if a folder is a valid sfdx project.
  *
@@ -119,7 +160,7 @@ export declare class SfProjectJson extends ConfigFile<ConfigFile.Options, Projec
      *
      * @param packageDir
      */
-    addPackageDirectory(packageDir: PackageDir): void;
+    addPackageDirectory(packageDir: NamedPackageDir): void;
     private doesPackageExist;
     private validateKeys;
 }
@@ -317,7 +358,3 @@ 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.isNamedPackagingDirectory = exports.isPackagingDirectory = exports.SfProject = exports.SfProjectJson = void 0;
+exports.SfProject = exports.SfProjectJson = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -282,7 +282,16 @@ class SfProjectJson extends configFile_1.ConfigFile {
      * @param packageDir
      */
     addPackageDirectory(packageDir) {
-        const dirIndex = this.getContents().packageDirectories.findIndex(findPackageDir(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));
+        });
         // 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
@@ -292,7 +301,6 @@ 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);
@@ -512,9 +520,7 @@ class SfProject {
      */
     getPackageNameFromPath(path) {
         const packageDir = this.getPackageFromPath(path);
-        if (!packageDir)
-            return undefined;
-        return (0, exports.isNamedPackagingDirectory)(packageDir) ? packageDir.package : packageDir.path;
+        return packageDir ? packageDir.package ?? packageDir.path : undefined;
     }
     /**
      * Returns the package directory.
@@ -582,7 +588,9 @@ class SfProject {
      */
     getDefaultPackage() {
         if (!this.hasPackages()) {
-            throw new sfError_1.SfError('The sfdx-project.json does not have any packageDirectories defined.');
+            throw new sfError_1.SfError('The sfdx-project.json does not have any packageDirectories defined.', 'NoPackageDirectories', [
+                `Check ${this.getPath()} for packageDirectories.`,
+            ]);
         }
         const defaultPackage = this.findPackage((packageDir) => packageDir.default === true);
         return defaultPackage ?? this.getPackageDirectories()[0];
@@ -658,19 +666,4 @@ 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/testSetup.js

@@ -532,6 +532,8 @@ const restoreContext = (testContext) => {
     testContext.configStubs = {};
     // Give each test run a clean StateAggregator
     stateAggregator_1.StateAggregator.clearInstance();
+    // @ts-expect-error accessing a private property
+    sfProject_1.SfProject.instances.clear();
     // Allow each test to have their own config aggregator
     // @ts-ignore clear for testing.
     delete configAggregator_1.ConfigAggregator.instance;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "7.3.12-qa.1",
+  "version": "7.4.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
@@ -83,7 +83,7 @@
     "benchmark": "^2.1.4",
     "chai-string": "^1.5.0",
     "ts-node": "^10.9.2",
-    "ts-patch": "^3.1.1",
+    "ts-patch": "^3.2.0",
     "typescript": "^5.4.5"
   },
   "repository": {