@salesforce/packaging 4.17.1 → 4.18.0

package/lib/package/packageConvert.d.ts

@@ -17,4 +17,4 @@ export declare function createPackageVersionCreateRequest(context: {
     seedmetadata?: string;
     patchversion?: string;
     codecoverage?: boolean;
-}, packageId: string, apiVersion: string): Promise<PackagingSObjects.Package2VersionCreateRequest>;
+}, packageId: string, apiVersion: string, project?: SfProject): Promise<PackagingSObjects.Package2VersionCreateRequest>;

package/lib/package/packageConvert.js

@@ -59,6 +59,7 @@ const node_os_1 = __importDefault(require("node:os"));
 const node_fs_1 = __importDefault(require("node:fs"));
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
+const project_1 = require("@salesforce/core/project");
 const pkgUtils = __importStar(require("../utils/packageUtils"));
 const packageUtils_1 = require("../utils/packageUtils");
 const interfaces_1 = require("../interfaces");
@@ -125,7 +126,7 @@ async function convertPackage(pkg, connection, options, project) {
     }, packageId, 
     // TODO: createPackageVersionCreateRequest requires apiVersion exist.
     // UT fail if we validate that it exists (there might not even be a project)
-    apiVersion);
+    apiVersion, project);
     // TODO: a lot of this is duplicated from PC, PVC, and PVCR.
     const createResult = await connection.tooling.create('Package2VersionCreateRequest', request);
     if (!createResult.success) {
@@ -163,7 +164,7 @@ async function convertPackage(pkg, connection, options, project) {
  * @returns {{Package2Id: string, Package2VersionMetadata: *, Tag: *, Branch: number}}
  * @private
  */
-async function createPackageVersionCreateRequest(context, packageId, apiVersion) {
+async function createPackageVersionCreateRequest(context, packageId, apiVersion, project) {
     const uniqueId = (0, packageUtils_1.uniqid)({ template: `${packageId}-%s` });
     const packageVersTmpRoot = node_path_1.default.join(node_os_1.default.tmpdir(), uniqueId);
     const packageVersMetadataFolder = node_path_1.default.join(packageVersTmpRoot, 'md-files');
@@ -173,10 +174,12 @@ async function createPackageVersionCreateRequest(context, packageId, apiVersion)
     const settingsZipFile = node_path_1.default.join(packageVersBlobDirectory, 'settings.zip');
     const metadataZipFile = node_path_1.default.join(packageVersBlobDirectory, 'package.zip');
     const packageVersBlobZipFile = node_path_1.default.join(packageVersTmpRoot, 'package-version-info.zip');
-    let packageDescriptorJson = {
-        id: packageId,
-        versionNumber: context.patchversion,
-    };
+    const packageObject = project ? (0, packageUtils_1.findPackageDirectory)(project, packageId) : undefined;
+    let packageDescriptorJson = buildPackageDescriptorJson({
+        packageId,
+        base: { versionNumber: context.patchversion },
+        packageObject,
+    });
     const settingsGenerator = new core_1.ScratchOrgSettingsGenerator({ asDirectory: true });
     const definitionFile = context.definitionfile;
     let definitionFileJson;
@@ -197,10 +200,11 @@ async function createPackageVersionCreateRequest(context, packageId, apiVersion)
     await node_fs_1.default.promises.mkdir(packageVersTmpRoot, { recursive: true });
     await node_fs_1.default.promises.mkdir(packageVersBlobDirectory, { recursive: true });
     await node_fs_1.default.promises.mkdir(packageVersMetadataFolder, { recursive: true });
-    const hasSeedMetadata = await new packageVersionCreate_1.MetadataResolver().resolveMetadata(context.seedmetadata, seedMetadataFolder, 'seedMDDirectoryDoesNotExist', apiVersion);
+    const seedMetadataPath = context.seedmetadata ?? packageDescriptorJson.seedMetadata?.path;
+    const hasSeedMetadata = await new packageVersionCreate_1.MetadataResolver().resolveMetadata(seedMetadataPath, seedMetadataFolder, 'seedMDDirectoryDoesNotExist', apiVersion);
     if (hasSeedMetadata) {
         // Zip the seedMetadataFolder folder and put the zip in {packageVersBlobDirectory}/{seedMetadataZipFile}
-        core_1.Logger.childFromRoot('packageConvert:pollForStatusWithInterval').debug(`Including metadata found in '${context.seedmetadata ?? '<undefined seedmetadata>'}'.`);
+        core_1.Logger.childFromRoot('packageConvert:pollForStatusWithInterval').debug(`Including metadata found in '${seedMetadataPath ?? '<undefined seedmetadata>'}'.`);
         await pkgUtils.zipDir(seedMetadataFolder, seedMetadataZipFile);
     }
     await settingsGenerator.createDeploy();
@@ -211,11 +215,32 @@ async function createPackageVersionCreateRequest(context, packageId, apiVersion)
     await node_fs_1.default.promises.writeFile(node_path_1.default.join(packageVersMetadataFolder, 'package.xml'), currentPackageXml, 'utf-8');
     // Zip the packageVersMetadataFolder folder and put the zip in {packageVersBlobDirectory}/package.zip
     await pkgUtils.zipDir(packageVersMetadataFolder, metadataZipFile);
+    packageDescriptorJson = (0, packageUtils_1.resolveBuildUserPermissions)(packageDescriptorJson, context.codecoverage ?? false);
+    packageDescriptorJson = (0, packageUtils_1.cleanPackageDescriptorJson)(packageDescriptorJson);
     await node_fs_1.default.promises.writeFile(node_path_1.default.join(packageVersBlobDirectory, 'package2-descriptor.json'), JSON.stringify(packageDescriptorJson, undefined, 2));
     // Zip the Version Info and package.zip files into another zip
     await pkgUtils.zipDir(packageVersBlobDirectory, packageVersBlobZipFile);
     return createRequestObject(packageId, context, packageVersTmpRoot, packageVersBlobZipFile);
 }
+function buildPackageDescriptorJson(args) {
+    const { packageId, base, packageObject } = args;
+    const descriptor = {
+        id: packageId,
+        ...(base ?? {}),
+    };
+    if (packageObject && (0, project_1.isPackagingDirectory)(packageObject)) {
+        const allowedKeys = ['apexTestAccess', 'seedMetadata'];
+        for (const key of allowedKeys) {
+            if (Object.prototype.hasOwnProperty.call(packageObject, key)) {
+                const value = packageObject[key];
+                if (value !== undefined) {
+                    descriptor[key] = value;
+                }
+            }
+        }
+    }
+    return descriptor;
+}
 async function createRequestObject(packageId, options, packageVersTmpRoot, packageVersBlobZipFile) {
     const zipFileBase64 = (await node_fs_1.default.promises.readFile(packageVersBlobZipFile)).toString('base64');
     const requestObject = {

package/lib/package/packageVersionCreate.d.ts

@@ -36,8 +36,6 @@ export declare class PackageVersionCreate {
     private createPackageVersionCreateRequestFromOptions;
     private verifyHasSource;
     private cleanGeneratedPackage;
-    /** side effect: modifies the passed in parameter! */
-    private resolveBuildUserPermissions;
     private packageVersionCreate;
     private getPackageDirFromId;
     private getPackageType;

package/lib/package/packageVersionCreate.js

@@ -350,7 +350,7 @@ class PackageVersionCreate {
             }
             packageDescriptorJson = (0, packageUtils_1.copyDescriptorProperties)(packageDescriptorJson, definitionFileJson);
         }
-        this.resolveBuildUserPermissions(packageDescriptorJson);
+        packageDescriptorJson = pkgUtils.resolveBuildUserPermissions(packageDescriptorJson, this.options.codecoverage ?? false);
         // All dependencies for the packaging dir should be resolved to an 04t id to be passed to the server.
         // (see resolveSubscriberPackageVersionId() for details)
         const dependencies = packageDescriptorJson.dependencies;
@@ -368,7 +368,7 @@ class PackageVersionCreate {
         if (resultValues.length > 0) {
             packageDescriptorJson.dependencies = resultValues;
         }
-        packageDescriptorJson = cleanPackageDescriptorJson(packageDescriptorJson);
+        packageDescriptorJson = pkgUtils.cleanPackageDescriptorJson(packageDescriptorJson);
         packageDescriptorJson = setPackageDescriptorJsonValues(packageDescriptorJson, this.options, this.logger);
         await node_fs_1.default.promises.mkdir(packageVersTmpRoot, { recursive: true });
         await node_fs_1.default.promises.mkdir(packageVersBlobDirectory, { recursive: true });
@@ -476,45 +476,6 @@ class PackageVersionCreate {
         // Zip the Version Info and package.zip files into another zip
         await (0, packageUtils_1.zipDir)(packageVersBlobDirectory, packageVersBlobZipFile);
     }
-    /** side effect: modifies the passed in parameter! */
-    resolveBuildUserPermissions(packageDescriptorJson) {
-        // Process permissionSet and permissionSetLicenses that should be enabled when running Apex tests
-        // This only applies if code coverage is enabled
-        if (this.options.codecoverage) {
-            // Assuming no permission sets are named 0, 0n, null, undefined, false, NaN, and the empty string
-            if (packageDescriptorJson.apexTestAccess?.permissionSets) {
-                let permSets = packageDescriptorJson.apexTestAccess.permissionSets;
-                if (!Array.isArray(permSets)) {
-                    permSets = permSets.split(',');
-                }
-                packageDescriptorJson.permissionSetNames = permSets.map((s) => s.trim());
-            }
-            if (packageDescriptorJson.apexTestAccess?.permissionSetLicenses) {
-                let permissionSetLicenses = packageDescriptorJson.apexTestAccess.permissionSetLicenses;
-                if (!Array.isArray(permissionSetLicenses)) {
-                    permissionSetLicenses = permissionSetLicenses.split(',');
-                }
-                packageDescriptorJson.permissionSetLicenseDeveloperNames = permissionSetLicenses.map((s) => s.trim());
-            }
-        }
-        // Process permissionSet and permissionsetLicenses that should be enabled for the package metadata deploy
-        if (packageDescriptorJson.packageMetadataAccess?.permissionSets) {
-            let permSets = packageDescriptorJson.packageMetadataAccess.permissionSets;
-            if (!Array.isArray(permSets)) {
-                permSets = permSets.split(',');
-            }
-            packageDescriptorJson.packageMetadataPermissionSetNames = permSets.map((s) => s.trim());
-        }
-        if (packageDescriptorJson.packageMetadataAccess?.permissionSetLicenses) {
-            let permissionSetLicenses = packageDescriptorJson.packageMetadataAccess.permissionSetLicenses;
-            if (!Array.isArray(permissionSetLicenses)) {
-                permissionSetLicenses = permissionSetLicenses.split(',');
-            }
-            packageDescriptorJson.packageMetadataPermissionSetLicenseNames = permissionSetLicenses.map((s) => s.trim());
-        }
-        delete packageDescriptorJson.apexTestAccess;
-        delete packageDescriptorJson.packageMetadataAccess;
-    }
     // eslint-disable-next-line complexity
     async packageVersionCreate() {
         // For the first rollout of validating sfdx-project.json data against schema, make it optional and defaulted
@@ -967,21 +928,4 @@ const setPackageDescriptorJsonValues = (packageDescriptorJson, options, logger)
     }
     return merged;
 };
-/**
- * Cleans client-side-only attribute(s) from the packageDescriptorJSON so it can go to API
- */
-const cleanPackageDescriptorJson = (packageDescriptorJson) => {
-    // properties only used by the client side
-    const clientOnlyProps = [
-        'default',
-        'includeProfileUserLicenses',
-        'unpackagedMetadata',
-        'seedMetadata',
-        'branch',
-        'fullPath',
-        'name',
-        'scopeProfiles',
-    ];
-    return Object.fromEntries(Object.entries(packageDescriptorJson).filter(([key]) => !clientOnlyProps.includes(key)));
-};
 //# sourceMappingURL=packageVersionCreate.js.map

package/lib/utils/packageUtils.d.ts

@@ -1,5 +1,6 @@
 import { Connection, ScratchOrgInfo, SfdcUrl, SfError, SfProject } from '@salesforce/core';
-import { Many } from '@salesforce/ts-types';
+import { NamedPackageDir } from '@salesforce/core/project';
+import { Many, Optional } from '@salesforce/ts-types';
 import type { SaveError } from '@jsforce/jsforce-node';
 import { Duration } from '@salesforce/kit';
 import { PackageDescriptorJson, PackageType, PackagingSObjects } from '../interfaces';
@@ -106,6 +107,28 @@ export declare function copyDir(src: string, dest: string): void;
  * overridden from definition file based on case-insensitive matches.
  */
 export declare function copyDescriptorProperties(packageDescriptorJson: PackageDescriptorJson, definitionFileJson: ScratchOrgInfo): PackageDescriptorJson;
+/**
+ * Resolve descriptor permissions for build/test execution.
+ *
+ * When {@link codecoverage} is true, converts {@link apexTestAccess} settings into
+ * permissionSetNames and permissionSetLicenseDeveloperNames.
+ * Always converts {@link packageMetadataAccess} settings into
+ * packageMetadataPermissionSetNames and packageMetadataPermissionSetLicenseNames.
+ * Removes apexTestAccess and packageMetadataAccess from the returned descriptor.
+ *
+ * @param descriptor Package descriptor to normalize
+ * @param codecoverage Whether to enable apexTestAccess-based permission processing
+ * @returns A normalized copy of the descriptor with flattened permission fields
+ */
+export declare function resolveBuildUserPermissions(descriptor: PackageDescriptorJson, codecoverage: boolean): PackageDescriptorJson;
+/**
+ * This function finds the package directory in the project that matches the given packageId
+ *
+ * @param project The SfProject instance to search
+ * @param packageId The package ID to match against
+ * @returns A NamedPackageDir or empty object if not found
+ */
+export declare function findPackageDirectory(project: SfProject | undefined, packageId: string): Optional<NamedPackageDir>;
 /**
  * Brand new SFDX projects contain a force-app directory tree containing empty folders
  * and a few .eslintrc.json files. We still want to consider such a directory tree
@@ -116,3 +139,7 @@ export declare function copyDescriptorProperties(packageDescriptorJson: PackageD
  * directories containing only an .eslintrc.json file.
  */
 export declare function isPackageDirectoryEffectivelyEmpty(directory: string): boolean;
+/**
+ * Cleans client-side-only attribute(s) from the packageDescriptorJSON so it can go to API
+ */
+export declare function cleanPackageDescriptorJson(packageDescriptorJson: PackageDescriptorJson): PackageDescriptorJson;

package/lib/utils/packageUtils.js

@@ -54,7 +54,10 @@ exports.numberToDuration = numberToDuration;
 exports.zipDir = zipDir;
 exports.copyDir = copyDir;
 exports.copyDescriptorProperties = copyDescriptorProperties;
+exports.resolveBuildUserPermissions = resolveBuildUserPermissions;
+exports.findPackageDirectory = findPackageDirectory;
 exports.isPackageDirectoryEffectivelyEmpty = isPackageDirectoryEffectivelyEmpty;
+exports.cleanPackageDescriptorJson = cleanPackageDescriptorJson;
 /*
  * Copyright 2025, Salesforce, Inc.
  *
@@ -77,6 +80,7 @@ const node_stream_1 = require("node:stream");
 const node_util_1 = __importStar(require("node:util"));
 const node_crypto_1 = require("node:crypto");
 const core_1 = require("@salesforce/core");
+const project_1 = require("@salesforce/core/project");
 const ts_types_1 = require("@salesforce/ts-types");
 const kit_1 = require("@salesforce/kit");
 const globby_1 = __importDefault(require("globby"));
@@ -450,6 +454,69 @@ function copyDescriptorProperties(packageDescriptorJson, definitionFileJson) {
         return [[prop], matchCase ? definitionFileJsonCopy[matchCase] : undefined];
     })));
 }
+/**
+ * Resolve descriptor permissions for build/test execution.
+ *
+ * When {@link codecoverage} is true, converts {@link apexTestAccess} settings into
+ * permissionSetNames and permissionSetLicenseDeveloperNames.
+ * Always converts {@link packageMetadataAccess} settings into
+ * packageMetadataPermissionSetNames and packageMetadataPermissionSetLicenseNames.
+ * Removes apexTestAccess and packageMetadataAccess from the returned descriptor.
+ *
+ * @param descriptor Package descriptor to normalize
+ * @param codecoverage Whether to enable apexTestAccess-based permission processing
+ * @returns A normalized copy of the descriptor with flattened permission fields
+ */
+function resolveBuildUserPermissions(descriptor, codecoverage) {
+    const copy = structuredClone(descriptor);
+    if (codecoverage) {
+        if (copy.apexTestAccess?.permissionSets) {
+            let permSets = copy.apexTestAccess.permissionSets;
+            if (!Array.isArray(permSets))
+                permSets = permSets.split(',');
+            copy.permissionSetNames = permSets.map((s) => s.trim());
+        }
+        if (copy.apexTestAccess?.permissionSetLicenses) {
+            let psl = copy.apexTestAccess.permissionSetLicenses;
+            if (!Array.isArray(psl))
+                psl = psl.split(',');
+            copy.permissionSetLicenseDeveloperNames = psl.map((s) => s.trim());
+        }
+    }
+    if (copy.packageMetadataAccess?.permissionSets) {
+        let permSets = copy.packageMetadataAccess.permissionSets;
+        if (!Array.isArray(permSets))
+            permSets = permSets.split(',');
+        copy.packageMetadataPermissionSetNames = permSets.map((s) => s.trim());
+    }
+    if (copy.packageMetadataAccess?.permissionSetLicenses) {
+        let psl = copy.packageMetadataAccess.permissionSetLicenses;
+        if (!Array.isArray(psl))
+            psl = psl.split(',');
+        copy.packageMetadataPermissionSetLicenseNames = psl.map((s) => s.trim());
+    }
+    delete copy.apexTestAccess;
+    delete copy.packageMetadataAccess;
+    return copy;
+}
+/**
+ * This function finds the package directory in the project that matches the given packageId
+ *
+ * @param project The SfProject instance to search
+ * @param packageId The package ID to match against
+ * @returns A NamedPackageDir or empty object if not found
+ */
+function findPackageDirectory(project, packageId) {
+    if (!project) {
+        return undefined;
+    }
+    return project.findPackage((namedPackageDir) => {
+        if (!(0, project_1.isPackagingDirectory)(namedPackageDir))
+            return false;
+        const dirPackageId = project.getPackageIdFromAlias(namedPackageDir.package) ?? namedPackageDir.package;
+        return dirPackageId === packageId;
+    });
+}
 /**
  * Brand new SFDX projects contain a force-app directory tree containing empty folders
  * and a few .eslintrc.json files. We still want to consider such a directory tree
@@ -468,4 +535,21 @@ function isPackageDirectoryEffectivelyEmpty(directory) {
         ? isPackageDirectoryEffectivelyEmpty((0, node_path_1.join)(directory, entry.name))
         : entry.name === '.eslintrc.json');
 }
+/**
+ * Cleans client-side-only attribute(s) from the packageDescriptorJSON so it can go to API
+ */
+function cleanPackageDescriptorJson(packageDescriptorJson) {
+    // properties only used by the client side
+    const clientOnlyProps = [
+        'default',
+        'includeProfileUserLicenses',
+        'unpackagedMetadata',
+        'seedMetadata',
+        'branch',
+        'fullPath',
+        'name',
+        'scopeProfiles',
+    ];
+    return Object.fromEntries(Object.entries(packageDescriptorJson).filter(([key]) => !clientOnlyProps.includes(key)));
+}
 //# sourceMappingURL=packageUtils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.17.1",
+  "version": "4.18.0",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -43,8 +43,8 @@
   ],
   "dependencies": {
     "@jsforce/jsforce-node": "^3.10.8",
-    "@salesforce/core": "^8.23.2",
-    "@salesforce/kit": "^3.2.3",
+    "@salesforce/core": "^8.23.3",
+    "@salesforce/kit": "^3.2.4",
     "@salesforce/schemas": "^1.10.3",
     "@salesforce/source-deploy-retrieve": "^12.24.0",
     "@salesforce/ts-types": "^2.0.11",