@salesforce/packaging 2.4.21 → 3.0.1

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -122,8 +122,6 @@ export type PackageDescriptorJson = Partial<NamedPackageDir> & Partial<{
     features: string[];
     orgPreferences: string[];
     snapshot: string;
-    unpackagedMetadata: NamedPackageDir;
-    seedMetadata: NamedPackageDir;
     apexTestAccess: {
         permissionSets: string[] | string;
         permissionSetLicenses: string[] | string;

package/lib/package/packageVersion.js

@@ -508,12 +508,15 @@ class PackageVersion {
             const version = `${aliases[0]}@${versionResult.MajorVersion ?? 0}.${versionResult.MinorVersion ?? 0}.${versionResult.PatchVersion ?? 0}`;
             const build = versionResult.BuildNumber ? `-${versionResult.BuildNumber}` : '';
             const branch = versionResult.Branch ? `-${versionResult.Branch}` : '';
-            // set packageAliases entry '<package>@<major>.<minor>.<patch>-<build>-<branch>: <result.subscriberPackageVersionId>'
-            const packageAliases = this.project.getSfProjectJson().getContents().packageAliases ?? {};
-            if (results.SubscriberPackageVersionId) {
-                packageAliases[`${version}${build}${branch}`] = results.SubscriberPackageVersionId;
-            }
-            this.project.getSfProjectJson().getContents().packageAliases = packageAliases;
+            const originalPackageAliases = this.project.getSfProjectJson().get('packageAliases') ?? {};
+            const updatedPackageAliases = {
+                ...originalPackageAliases,
+                ...(results.SubscriberPackageVersionId
+                    ? // set packageAliases entry '<package>@<major>.<minor>.<patch>-<build>-<branch>: <result.subscriberPackageVersionId>'
+                        { [`${version}${build}${branch}`]: results.SubscriberPackageVersionId }
+                    : {}),
+            };
+            this.project.getSfProjectJson().set('packageAliases', updatedPackageAliases);
             await this.project.getSfProjectJson().write();
         }
     }

package/lib/package/packageVersionCreate.d.ts

@@ -1,5 +1,5 @@
 import { ConvertResult } from '@salesforce/source-deploy-retrieve';
-import { MDFolderForArtifactOptions, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageXml } from '../interfaces';
+import { MDFolderForArtifactOptions, PackageVersionCreateOptions, PackageVersionCreateRequestResult, PackageXml, PackagingSObjects } from '../interfaces';
 export declare class PackageVersionCreate {
     private options;
     private apiVersionFromPackageXml;
@@ -38,18 +38,8 @@ export declare class PackageVersionCreate {
     private getPackageDirFromId;
     private getPackageType;
     private validateOptionsForPackageType;
-    /**
-     * Cleans invalid attribute(s) from the packageDescriptorJSON
-     */
-    private cleanPackageDescriptorJson;
-    /**
-     * Sets default or override values for packageDescriptorJSON attribs
-     */
-    private setPackageDescriptorJsonValues;
-    private validateVersionNumber;
     private validatePatchVersion;
     private getAncestorId;
-    private validateAncestorId;
     private getAncestorIdHighestRelease;
 }
 export declare class MetadataResolver {
@@ -70,3 +60,5 @@ export declare const packageXmlStringToPackageXmlJson: (rawXml: string) => Packa
  * Converts PackageXmlJson to a string representing the Xml
  * */
 export declare const packageXmlJsonToXmlString: (packageXmlJson: PackageXml) => string;
+export declare const validateAncestorId: (ancestorId: string, highestReleasedVersion: PackagingSObjects.Package2Version | null | undefined, explicitUseNoAncestor: boolean, isPatch: boolean, skipAncestorCheck: boolean, origSpecifiedAncestor: string) => string;
+export declare const validateVersionNumber: (versionNumberString: string, supportedBuildNumberToken: string, supportedBuildNumberToken2?: string) => string;

package/lib/package/packageVersionCreate.js

@@ -6,7 +6,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.packageXmlJsonToXmlString = exports.packageXmlStringToPackageXmlJson = exports.MetadataResolver = exports.PackageVersionCreate = void 0;
+exports.validateVersionNumber = exports.validateAncestorId = exports.packageXmlJsonToXmlString = exports.packageXmlStringToPackageXmlJson = exports.MetadataResolver = exports.PackageVersionCreate = void 0;
 const path = require("node:path");
 const os = require("node:os");
 const fs = require("node:fs");
@@ -15,6 +15,7 @@ const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const scratchOrgSettingsGenerator_1 = require("@salesforce/core/lib/org/scratchOrgSettingsGenerator");
 const kit_1 = require("@salesforce/kit");
 const fast_xml_parser_1 = require("fast-xml-parser");
+const ts_types_1 = require("@salesforce/ts-types");
 const pkgUtils = require("../utils/packageUtils");
 const packageUtils_1 = require("../utils/packageUtils");
 const interfaces_1 = require("../interfaces");
@@ -69,7 +70,7 @@ class PackageVersionCreate {
         // Just override dependency.packageId value to the resolved alias.
         dependency.packageId = packageIdFromAlias;
         pkgUtils.validateId(pkgUtils.BY_LABEL.PACKAGE_ID, dependency.packageId);
-        this.validateVersionNumber(dependency.versionNumber, versionNumber_1.BuildNumberToken.LATEST_BUILD_NUMBER_TOKEN, versionNumber_1.BuildNumberToken.RELEASED_BUILD_NUMBER_TOKEN);
+        (0, exports.validateVersionNumber)(dependency.versionNumber, versionNumber_1.BuildNumberToken.LATEST_BUILD_NUMBER_TOKEN, versionNumber_1.BuildNumberToken.RELEASED_BUILD_NUMBER_TOKEN);
         await this.validatePatchVersion(dependency.versionNumber, dependency.packageId);
         // Validate that the Package2 id exists on the server
         const query = `SELECT Id FROM Package2 WHERE Id = '${dependency.packageId}'`;
@@ -294,8 +295,8 @@ class PackageVersionCreate {
         if (resultValues.length > 0) {
             packageDescriptorJson.dependencies = resultValues;
         }
-        this.cleanPackageDescriptorJson(packageDescriptorJson);
-        this.setPackageDescriptorJsonValues(packageDescriptorJson);
+        packageDescriptorJson = cleanPackageDescriptorJson(packageDescriptorJson);
+        packageDescriptorJson = setPackageDescriptorJsonValues(packageDescriptorJson, this.options, this.logger);
         await fs.promises.mkdir(packageVersTmpRoot, { recursive: true });
         await fs.promises.mkdir(packageVersBlobDirectory, { recursive: true });
         if (Reflect.has(packageDescriptorJson, 'ancestorVersion')) {
@@ -364,7 +365,7 @@ class PackageVersionCreate {
             profileExcludeDirs = this.project
                 .getPackageDirectories()
                 .map((packageDir) => packageDir.unpackagedMetadata?.path)
-                .filter((packageDirPath) => packageDirPath);
+                .filter(ts_types_1.isString);
             let debugMsg = 'Searching for profiles to include from all packageDirectories';
             if (profileExcludeDirs?.length) {
                 debugMsg += ` excluding these unpackagedMetadata dirs: ${profileExcludeDirs.toString()}`;
@@ -509,9 +510,8 @@ class PackageVersionCreate {
         return (await (0, packageVersionCreateRequest_1.byId)(createResult.id, this.connection))[0];
     }
     async getPackageDirFromId(pkg) {
-        let dir;
         if (pkg.startsWith('0Ho')) {
-            dir = (await this.project.getSfProjectJson().getPackageDirectories()).filter((p) => p.package === pkg);
+            const dir = (await this.project.getSfProjectJson().getPackageDirectories()).filter((p) => p.package === pkg);
             if (dir.length === 1) {
                 return dir[0];
             }
@@ -540,83 +540,6 @@ class PackageVersionCreate {
             }
         }
     }
-    /**
-     * Cleans invalid attribute(s) from the packageDescriptorJSON
-     */
-    // eslint-disable-next-line class-methods-use-this
-    cleanPackageDescriptorJson(packageDescriptorJson) {
-        delete packageDescriptorJson.default; // for client-side use only, not needed
-        delete packageDescriptorJson.includeProfileUserLicenses; // for client-side use only, not needed
-        delete packageDescriptorJson.unpackagedMetadata; // for client-side use only, not needed
-        delete packageDescriptorJson.seedMetadata; // for client-side use only, not needed
-        delete packageDescriptorJson.branch; // for client-side use only, not needed
-        delete packageDescriptorJson.fullPath; // for client-side use only, not needed
-        delete packageDescriptorJson.name; // for client-side use only, not needed
-        delete packageDescriptorJson.scopeProfiles; // for client-side use only, not needed
-        return packageDescriptorJson;
-    }
-    /**
-     * Sets default or override values for packageDescriptorJSON attribs
-     */
-    setPackageDescriptorJsonValues(packageDescriptorJson) {
-        const options = this.options;
-        if (options.versionname) {
-            packageDescriptorJson.versionName = options.versionname;
-        }
-        if (options.versiondescription) {
-            packageDescriptorJson.versionDescription = options.versiondescription;
-        }
-        if (options.versionnumber) {
-            packageDescriptorJson.versionNumber = options.versionnumber;
-        }
-        // default versionName to versionNumber if unset, stripping .NEXT if present
-        if (!packageDescriptorJson.versionName) {
-            const versionNumber = packageDescriptorJson.versionNumber;
-            packageDescriptorJson.versionName =
-                versionNumber?.split(pkgUtils.VERSION_NUMBER_SEP)[3] === versionNumber_1.BuildNumberToken.NEXT_BUILD_NUMBER_TOKEN
-                    ? versionNumber.substring(0, versionNumber.indexOf(pkgUtils.VERSION_NUMBER_SEP + versionNumber_1.BuildNumberToken.NEXT_BUILD_NUMBER_TOKEN))
-                    : versionNumber;
-            this.logger.warn(messages.getMessage('defaultVersionName', [packageDescriptorJson.versionName]));
-        }
-        if (options.releasenotesurl) {
-            packageDescriptorJson.releaseNotesUrl = options.releasenotesurl;
-        }
-        if (packageDescriptorJson.releaseNotesUrl && !core_1.SfdcUrl.isValidUrl(packageDescriptorJson.releaseNotesUrl)) {
-            throw messages.createError('malformedUrl', ['releaseNotesUrl', packageDescriptorJson.releaseNotesUrl]);
-        }
-        if (options.postinstallurl) {
-            packageDescriptorJson.postInstallUrl = options.postinstallurl;
-        }
-        if (packageDescriptorJson.postInstallUrl && !core_1.SfdcUrl.isValidUrl(packageDescriptorJson.postInstallUrl)) {
-            throw messages.createError('malformedUrl', ['postInstallUrl', packageDescriptorJson.postInstallUrl]);
-        }
-        if (options.postinstallscript) {
-            packageDescriptorJson.postInstallScript = options.postinstallscript;
-        }
-        if (options.uninstallscript) {
-            packageDescriptorJson.uninstallScript = options.uninstallscript;
-        }
-    }
-    // eslint-disable-next-line class-methods-use-this
-    validateVersionNumber(versionNumberString, supportedBuildNumberToken, supportedBuildNumberToken2) {
-        const versionNumber = versionNumber_1.VersionNumber.from(versionNumberString);
-        // build number can be a number or valid token
-        if (Number.isNaN(parseInt(`${versionNumber.build}`, 10)) &&
-            versionNumber.build !== supportedBuildNumberToken &&
-            versionNumber.build !== supportedBuildNumberToken2) {
-            if (supportedBuildNumberToken2) {
-                throw messages.createError('errorInvalidBuildNumberForKeywords', [
-                    versionNumberString,
-                    supportedBuildNumberToken,
-                    supportedBuildNumberToken2,
-                ]);
-            }
-            else {
-                throw messages.createError('errorInvalidBuildNumber', [versionNumberString, supportedBuildNumberToken]);
-            }
-        }
-        return versionNumberString;
-    }
     async validatePatchVersion(versionNumberString, packageId) {
         const query = `SELECT ContainerOptions FROM Package2 WHERE id ='${packageId}'`;
         const queryResult = await this.connection.tooling.query(query);
@@ -715,34 +638,7 @@ class PackageVersionCreate {
             ancestorId = queriedAncestorId;
             origSpecifiedAncestor = packageDescriptorJson.ancestorVersion;
         }
-        return this.validateAncestorId(ancestorId, highestReleasedVersion, explicitUseNoAncestor, versionNumber.patch !== '0', skipAncestorCheck, origSpecifiedAncestor);
-    }
-    // eslint-disable-next-line class-methods-use-this
-    validateAncestorId(ancestorId, highestReleasedVersion, explicitUseNoAncestor, isPatch, skipAncestorCheck, origSpecifiedAncestor) {
-        if (explicitUseNoAncestor) {
-            if (!highestReleasedVersion) {
-                return '';
-            }
-            else {
-                // the explicitUseNoAncestor && skipAncestorCheck case is handled above
-                throw messages.createError('errorAncestorNoneNotAllowed', [(0, packageUtils_1.getPackageVersionNumber)(highestReleasedVersion)]);
-            }
-        }
-        if (!isPatch && !skipAncestorCheck) {
-            if (highestReleasedVersion) {
-                if (highestReleasedVersion.Id !== ancestorId) {
-                    throw messages.createError('errorAncestorNotHighest', [
-                        origSpecifiedAncestor,
-                        (0, packageUtils_1.getPackageVersionNumber)(highestReleasedVersion),
-                    ]);
-                }
-            }
-            else {
-                // looks like the initial version:create - allow
-                ancestorId = '';
-            }
-        }
-        return ancestorId;
+        return (0, exports.validateAncestorId)(ancestorId, highestReleasedVersion, explicitUseNoAncestor, versionNumber.patch !== '0', skipAncestorCheck, origSpecifiedAncestor);
     }
     async getAncestorIdHighestRelease(packageId, versionNumberString, explicitUseHighestRelease, skipAncestorCheck) {
         if (!packageId) {
@@ -901,4 +797,97 @@ const packageXmlJsonToXmlString = (packageXmlJson) => {
     }));
 };
 exports.packageXmlJsonToXmlString = packageXmlJsonToXmlString;
+// exported for UT
+const validateAncestorId = (ancestorId, highestReleasedVersion, explicitUseNoAncestor, isPatch, skipAncestorCheck, origSpecifiedAncestor) => {
+    if (explicitUseNoAncestor) {
+        if (!highestReleasedVersion) {
+            return '';
+        }
+        else {
+            // the explicitUseNoAncestor && skipAncestorCheck case is handled above
+            throw messages.createError('errorAncestorNoneNotAllowed', [(0, packageUtils_1.getPackageVersionNumber)(highestReleasedVersion)]);
+        }
+    }
+    if (!isPatch && !skipAncestorCheck) {
+        if (highestReleasedVersion) {
+            if (highestReleasedVersion.Id !== ancestorId) {
+                throw messages.createError('errorAncestorNotHighest', [
+                    origSpecifiedAncestor,
+                    (0, packageUtils_1.getPackageVersionNumber)(highestReleasedVersion),
+                ]);
+            }
+        }
+        else {
+            // looks like the initial version:create - allow
+            ancestorId = '';
+        }
+    }
+    return ancestorId;
+};
+exports.validateAncestorId = validateAncestorId;
+const validateVersionNumber = (versionNumberString, supportedBuildNumberToken, supportedBuildNumberToken2) => {
+    const versionNumber = versionNumber_1.VersionNumber.from(versionNumberString);
+    // build number can be a number or valid token
+    if (Number.isNaN(parseInt(`${versionNumber.build}`, 10)) &&
+        versionNumber.build !== supportedBuildNumberToken &&
+        versionNumber.build !== supportedBuildNumberToken2) {
+        if (supportedBuildNumberToken2) {
+            throw messages.createError('errorInvalidBuildNumberForKeywords', [
+                versionNumberString,
+                supportedBuildNumberToken,
+                supportedBuildNumberToken2,
+            ]);
+        }
+        else {
+            throw messages.createError('errorInvalidBuildNumber', [versionNumberString, supportedBuildNumberToken]);
+        }
+    }
+    return versionNumberString;
+};
+exports.validateVersionNumber = validateVersionNumber;
+/**
+ * Sets default or override values for packageDescriptorJSON attribs
+ */
+const setPackageDescriptorJsonValues = (packageDescriptorJson, options, logger) => {
+    const merged = {
+        ...packageDescriptorJson,
+        ...(options.versionname ? { versionName: options.versionname } : {}),
+        ...(options.versiondescription ? { versionDescription: options.versiondescription } : {}),
+        ...(options.versionnumber ? { versionNumber: options.versionnumber } : {}),
+        ...(options.releasenotesurl ? { releaseNotesUrl: options.releasenotesurl } : {}),
+        ...(options.postinstallurl ? { postInstallUrl: options.postinstallurl } : {}),
+        ...(options.postinstallscript ? { postInstallScript: options.postinstallscript } : {}),
+        ...(options.postinstallurl ? { postInstallUrl: options.postinstallurl } : {}),
+    };
+    if (merged.postInstallUrl && !core_1.SfdcUrl.isValidUrl(merged.postInstallUrl)) {
+        throw messages.createError('malformedUrl', ['postInstallUrl', merged.postInstallUrl]);
+    }
+    // default versionName to versionNumber if unset, stripping .NEXT if present
+    if (!merged.versionName) {
+        const versionNumber = merged.versionNumber;
+        merged.versionName =
+            versionNumber?.split(pkgUtils.VERSION_NUMBER_SEP)[3] === versionNumber_1.BuildNumberToken.NEXT_BUILD_NUMBER_TOKEN
+                ? versionNumber.substring(0, versionNumber.indexOf(pkgUtils.VERSION_NUMBER_SEP + versionNumber_1.BuildNumberToken.NEXT_BUILD_NUMBER_TOKEN))
+                : versionNumber;
+        logger.warn(messages.getMessage('defaultVersionName', [merged.versionName]));
+    }
+    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/package/packageVersionRetrieve.js

@@ -139,8 +139,8 @@ async function attemptToUpdateProjectJson(project, connection, packageId, subscr
                 const packageVersionVersionString = `${version.MajorVersion}.${version.MinorVersion}.${version.PatchVersion}-${version.BuildNumber}`;
                 const [alias, writtenId] = await (0, packageUtils_1.generatePackageAliasEntry)(connection, project, subscriberPackageVersionId, packageVersionVersionString, 'main', pkg.getId());
                 project.getSfProjectJson().addPackageAlias(alias, writtenId);
-                if (pkgData.ContainerOptions === 'Managed' && !project.getSfProjectJson().getContents().namespace) {
-                    project.getSfProjectJson().getContents().namespace = pkgData.NamespacePrefix;
+                if (pkgData.ContainerOptions === 'Managed' && !project.getSfProjectJson().get('namespace')) {
+                    project.getSfProjectJson().set('namespace', pkgData.NamespacePrefix);
                 }
                 await project.getSfProjectJson().write();
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "2.4.21",
+  "version": "3.0.1",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -8,7 +8,6 @@
   "repository": "forcedotcom/packaging",
   "scripts": {
     "build": "wireit",
-    "ci-docs": "yarn sf-ci-docs",
     "clean": "sf-clean",
     "clean-all": "sf-clean all",
     "compile": "wireit",
@@ -32,7 +31,7 @@
     "packaging"
   ],
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "docs",
@@ -42,10 +41,10 @@
   ],
   "dependencies": {
     "@oclif/core": "^2.15.0",
-    "@salesforce/core": "^5.3.14",
+    "@salesforce/core": "^6.1.3",
     "@salesforce/kit": "^3.0.15",
     "@salesforce/schemas": "^1.6.1",
-    "@salesforce/source-deploy-retrieve": "^9.8.5",
+    "@salesforce/source-deploy-retrieve": "^10.0.0",
     "@salesforce/ts-types": "^2.0.9",
     "fast-xml-parser": "^4.3.1",
     "globby": "^11",