@salesforce/packaging 4.1.5 → 4.1.6

package/lib/package/package.js

@@ -55,6 +55,9 @@ exports.Package2Fields = [
  * `const pkgList = await Package.list(connection);`
  */
 class Package {
+    options;
+    packageId;
+    packageData;
     constructor(options) {
         this.options = options;
         let packageId = this.options.packageAliasOrId;

package/lib/package/packageAncestry.js

@@ -71,11 +71,13 @@ const sortAncestryNodeData = (a, b) => {
  * Given a package Id (0Ho) or a package version Id (04t), it will build a graph of the package's ancestors.
  */
 class PackageAncestry extends kit_1.AsyncCreatable {
+    options;
+    roots = [];
+    graph = new graphology_1.DirectedGraph();
+    packageId;
     constructor(options) {
         super(options);
         this.options = options;
-        this.roots = [];
-        this.graph = new graphology_1.DirectedGraph();
         this.packageId = options.packageId;
     }
     get requestedPackageId() {
@@ -283,7 +285,7 @@ class PackageAncestry extends kit_1.AsyncCreatable {
         // Check to see if the package is an unlocked package
         // if so, throw and error since ancestry only applies to managed packages
         await this.validatePackageType();
-        const normalQuery = `${SELECT_PACKAGE_VERSION} WHERE AncestorId = NULL AND Package2Id = '${this.requestedPackageId}' ${releasedOnlyFilter}`;
+        const normalQuery = `${SELECT_PACKAGE_VERSION} WHERE AncestorId = NULL AND Package2Id = '${this.requestedPackageId ?? ''}' ${releasedOnlyFilter}`;
         const subscriberPackageVersions = (await this.options.connection.tooling.query(normalQuery)).records?.map((record) => new PackageAncestryNode(record));
         // The package exists, but there are no versions for the provided package
         if (subscriberPackageVersions.length === 0) {
@@ -329,9 +331,7 @@ class PackageAncestry extends kit_1.AsyncCreatable {
 }
 exports.PackageAncestry = PackageAncestry;
 class Tree {
-    constructor() {
-        this.nodes = {};
-    }
+    nodes = {};
     // eslint-disable-next-line no-console
     display(logger = console.log) {
         const addNodes = function (nodes) {
@@ -361,6 +361,9 @@ class Tree {
     }
 }
 class AncestryTreeProducer extends Tree {
+    label;
+    options;
+    verbose;
     constructor(options) {
         super();
         this.options = options;
@@ -405,8 +408,11 @@ class AncestryTreeProducer extends Tree {
 }
 exports.AncestryTreeProducer = AncestryTreeProducer;
 class AncestryJsonProducer {
+    label;
+    options;
+    children = [];
+    data;
     constructor(options) {
-        this.children = [];
         this.options = options;
         this.label = this.options?.packageNode?.getVersion() ?? 'root';
         this.data = {
@@ -440,8 +446,10 @@ class AncestryJsonProducer {
 }
 exports.AncestryJsonProducer = AncestryJsonProducer;
 class AncestryDotProducer {
+    label;
+    options;
+    children = [];
     constructor(options) {
-        this.children = [];
         this.options = options;
         this.label = this.options?.packageNode?.getVersion() ?? 'root';
     }
@@ -497,10 +505,18 @@ class AncestryDotProducer {
 }
 exports.AncestryDotProducer = AncestryDotProducer;
 class PackageAncestryNode extends kit_1.AsyncCreatable {
+    options;
+    version;
+    MajorVersion;
+    MinorVersion;
+    PatchVersion;
+    BuildNumber;
+    AncestorId;
+    SubscriberPackageVersionId;
+    depthCounter = 0;
     constructor(options) {
         super(options);
         this.options = options;
-        this.depthCounter = 0;
         this.version = new versionNumber_1.VersionNumber(this.options.MajorVersion, this.options.MinorVersion, this.options.PatchVersion, this.options.BuildNumber);
         this.AncestorId = this.options.AncestorId;
         this.SubscriberPackageVersionId = this.options.SubscriberPackageVersionId;

package/lib/package/packageConvert.js

@@ -165,13 +165,13 @@ async function createPackageVersionCreateRequest(context, packageId, apiVersion)
     const hasSeedMetadata = await new packageVersionCreate_1.MetadataResolver().resolveMetadata(context.seedmetadata, 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}'.`);
+        core_1.Logger.childFromRoot('packageConvert:pollForStatusWithInterval').debug(`Including metadata found in '${context.seedmetadata ?? '<undefined seedmetadata>'}'.`);
         await pkgUtils.zipDir(seedMetadataFolder, seedMetadataZipFile);
     }
     await settingsGenerator.createDeploy();
     await settingsGenerator.createDeployPackageContents(apiVersion);
-    await pkgUtils.zipDir(`${settingsGenerator.getDestinationPath()}${node_path_1.default.sep}${settingsGenerator.getShapeDirName()}`, settingsZipFile);
-    const shapeDirectory = `${settingsGenerator.getDestinationPath()}${node_path_1.default.sep}${settingsGenerator.getShapeDirName()}`;
+    await pkgUtils.zipDir(`${settingsGenerator.getDestinationPath() ?? ''}${node_path_1.default.sep}${settingsGenerator.getShapeDirName()}`, settingsZipFile);
+    const shapeDirectory = `${settingsGenerator.getDestinationPath() ?? ''}${node_path_1.default.sep}${settingsGenerator.getShapeDirName()}`;
     const currentPackageXml = await node_fs_1.default.promises.readFile(node_path_1.default.join(shapeDirectory, 'package.xml'), 'utf8');
     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

package/lib/package/packageProfileApi.js

@@ -25,9 +25,10 @@ const profileApiMessages = core_1.Messages.loadMessages('@salesforce/packaging',
  * profile that is relevant to the source in the package directory being packaged.
  */
 class PackageProfileApi extends kit_1.AsyncCreatable {
+    project;
+    includeUserLicenses = false;
     constructor(options) {
         super(options);
-        this.includeUserLicenses = false;
         this.project = options.project;
         this.includeUserLicenses = options.includeUserLicenses ?? false;
     }

package/lib/package/packageVersion.d.ts

@@ -63,7 +63,7 @@ export declare class PackageVersion {
     static create(options: PackageVersionCreateOptions, polling?: {
         frequency: Duration;
         timeout: Duration;
-    }): Promise<Partial<PackageVersionCreateRequestResult>>;
+    }): Promise<PackageVersionCreateRequestResult>;
     /**
      * Gets current state of a package version create request.
      *

package/lib/package/packageVersion.js

@@ -71,6 +71,12 @@ exports.Package2VersionFields = [
  * `new PackageVersion({connection, project, idOrAlias}).promote();`
  */
 class PackageVersion {
+    options;
+    project;
+    connection;
+    data;
+    packageType;
+    id;
     constructor(options) {
         this.options = options;
         this.connection = this.options.connection;
@@ -323,8 +329,9 @@ class PackageVersion {
         return result.records ?? [];
     }
     static getPackage2VersionFields(connection) {
-        const apiVersion = connection.getApiVersion();
-        return exports.Package2VersionFields.filter((field) => (apiVersion > '60.0' ? true : field !== 'ValidatedAsync'));
+        return parseInt(connection.getApiVersion(), 10) > 60
+            ? exports.Package2VersionFields
+            : exports.Package2VersionFields.filter((field) => field !== 'ValidatedAsync');
     }
     /**
      * Get the package version ID for this PackageVersion.
@@ -366,7 +373,7 @@ class PackageVersion {
      */
     async getPackageType() {
         if (!this.packageType) {
-            this.packageType = (await this.connection.singleRecordQuery(`select ContainerOptions from Package2 where Id = '${await this.getPackageId()}' limit 1`, { tooling: true })).ContainerOptions;
+            this.packageType = (await this.connection.singleRecordQuery(`select ContainerOptions from Package2 where Id = '${(await this.getPackageId()) ?? ''}' limit 1`, { tooling: true })).ContainerOptions;
         }
         return this.packageType;
     }
@@ -377,37 +384,30 @@ class PackageVersion {
      * @returns Package2Version
      */
     async getData(force = false) {
-        let is05i = false;
         if (!this.data || force) {
             // validate ID
             if (this.id.startsWith('04t')) {
                 (0, packageUtils_1.validateId)(packageUtils_1.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, this.id);
-                is05i = false;
             }
             else if (this.id.startsWith('05i')) {
                 (0, packageUtils_1.validateId)(packageUtils_1.BY_LABEL.PACKAGE_VERSION_ID, this.id);
-                is05i = true;
             }
             else {
                 throw messages.createError('errorInvalidPackageVersionId', [this.options.idOrAlias]);
             }
-            let queryConfig;
-            if (is05i) {
-                queryConfig = {
+            const queryConfig = this.id.startsWith('05i')
+                ? {
                     id: this.id,
                     clause: `Id = '${this.id}'`,
                     label1: packageUtils_1.BY_LABEL.PACKAGE_VERSION_ID.label,
                     label2: packageUtils_1.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID.label,
-                };
-            }
-            else {
-                queryConfig = {
+                }
+                : {
                     id: this.id,
                     clause: `SubscriberPackageVersionId = '${this.id}'`,
                     label1: packageUtils_1.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID.label,
                     label2: packageUtils_1.BY_LABEL.PACKAGE_VERSION_ID.label,
                 };
-            }
             const allFields = PackageVersion.getPackage2VersionFields(this.connection).toString();
             const query = `SELECT ${allFields} FROM Package2Version WHERE ${queryConfig.clause} LIMIT 1`;
             try {
@@ -512,7 +512,7 @@ class PackageVersion {
     async updateProjectWithPackageVersion(results) {
         if (!kit_1.env.getBoolean('SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE')) {
             // get the newly created package version from the server
-            const versionResult = (await this.connection.tooling.query(`SELECT Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId='${results.SubscriberPackageVersionId}'`)).records[0];
+            const versionResult = (await this.connection.tooling.query(`SELECT Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId='${results.SubscriberPackageVersionId ?? ''}'`)).records[0];
             const aliases = this.project.getAliasesFromPackageId(results.Package2Id);
             if (aliases.length === 0) {
                 throw messages.createError('packageAliasNotFound', [results.Package2Id]);

package/lib/package/packageVersionCreate.d.ts

@@ -11,7 +11,7 @@ export declare class PackageVersionCreate {
     private readonly logger;
     private metadataResolver;
     constructor(options: PackageVersionCreateOptions);
-    createPackageVersion(): Promise<Partial<PackageVersionCreateRequestResult>>;
+    createPackageVersion(): Promise<PackageVersionCreateRequestResult>;
     /**
      * A dependency in the project config file may be specified using either a subscriber package version id (04t)
      * or a package Id (0Ho) + a version number.  Additionally, a build number may be the actual build number, or a
@@ -21,6 +21,7 @@ export declare class PackageVersionCreate {
      * and adds it as a SubscriberPackageVersionId parameter in the dependency object.
      */
     retrieveSubscriberPackageVersionId(dependency: PackageDescriptorJson): Promise<string>;
+    /** side effect: removes properties from the passed in dependency! */
     private resolveSubscriberPackageVersionId;
     private validateDependencyValues;
     private resolveBuildNumber;
@@ -34,6 +35,7 @@ export declare class PackageVersionCreate {
     private createPackageVersionCreateRequestFromOptions;
     private verifyHasSource;
     private cleanGeneratedPackage;
+    /** side effect: modifies the passed in parameter! */
     private resolveBuildUserPermissions;
     private packageVersionCreate;
     private getPackageDirFromId;

package/lib/package/packageVersionCreate.js

@@ -53,6 +53,15 @@ core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package_version_create');
 const DESCRIPTOR_FILE = 'package2-descriptor.json';
 class PackageVersionCreate {
+    options;
+    apiVersionFromPackageXml;
+    project;
+    connection;
+    packageObject;
+    packageId;
+    pkg;
+    logger;
+    metadataResolver;
     constructor(options) {
         this.options = options;
         this.connection = this.options.connection;
@@ -131,6 +140,7 @@ class PackageVersionCreate {
         }
         return pkgVerQueryResult.records[0].SubscriberPackageVersionId;
     }
+    /** side effect: removes properties from the passed in dependency! */
     async resolveSubscriberPackageVersionId(dependency) {
         await this.validateDependencyValues(dependency);
         if (dependency.subscriberPackageVersionId) {
@@ -436,11 +446,12 @@ class PackageVersionCreate {
         if (settingsGenerator.hasSettings()) {
             await settingsGenerator.createDeploy();
             await settingsGenerator.createDeployPackageContents(this.apiVersionFromPackageXml);
-            await (0, packageUtils_1.zipDir)(`${settingsGenerator.getDestinationPath()}${node_path_1.default.sep}${settingsGenerator.getShapeDirName()}`, settingsZipFile);
+            await (0, packageUtils_1.zipDir)(`${settingsGenerator.getDestinationPath() ?? ''}${node_path_1.default.sep}${settingsGenerator.getShapeDirName()}`, settingsZipFile);
         }
         // 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
@@ -671,7 +682,7 @@ class PackageVersionCreate {
                 throw new Error(messages.getMessage('errorInvalidAncestorVersionFormat', [packageDescriptorJson.ancestorVersion]));
             }
             const query = 'SELECT Id, IsReleased FROM Package2Version ' +
-                `WHERE Package2Id = '${packageId}' AND MajorVersion = ${versionNumberSplit[0]} AND MinorVersion = ${versionNumberSplit[1]} AND PatchVersion = ${versionNumberSplit[2]}`;
+                `WHERE Package2Id = '${packageId ?? ''}' AND MajorVersion = ${versionNumberSplit[0]} AND MinorVersion = ${versionNumberSplit[1]} AND PatchVersion = ${versionNumberSplit[2]}`;
             let queriedAncestorId;
             const ancestorVersionResult = await this.connection.tooling.query(query);
             if (!ancestorVersionResult.totalSize) {

package/lib/package/subscriberPackageVersion.js

@@ -91,6 +91,11 @@ const allZeroesInstallOptions = {
  * `const installStatus = await new SubscriberPackageVersion(options).install(request, options);`
  */
 class SubscriberPackageVersion {
+    options;
+    password;
+    connection;
+    id;
+    data;
     constructor(options) {
         this.options = options;
         this.connection = this.options.connection;

package/lib/package/versionNumber.js

@@ -19,6 +19,10 @@ var BuildNumberToken;
     BuildNumberToken["NONE_VERSION_NUMBER_TOKEN"] = "NONE";
 })(BuildNumberToken || (exports.BuildNumberToken = BuildNumberToken = {}));
 class VersionNumber {
+    major;
+    minor;
+    patch;
+    build;
     constructor(major, minor, patch, build) {
         this.major = major;
         this.minor = minor;

package/lib/package1/package1Version.js

@@ -32,6 +32,8 @@ const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package1
  * More implementation examples are in the plugin here: https://github.com/salesforcecli/plugin-packaging/tree/main/src/commands/force/package1/
  */
 class Package1Version {
+    connection;
+    id;
     /**
      * Package1Version Constructor - Class to be used with 1st generation package versions
      *

package/lib/utils/packageUtils.d.ts

@@ -1,5 +1,5 @@
 import { Connection, ScratchOrgInfo, SfdcUrl, SfError, SfProject } from '@salesforce/core';
-import { Many, Nullable } from '@salesforce/ts-types';
+import { Many } from '@salesforce/ts-types';
 import type { SaveError } from '@jsforce/jsforce-node';
 import { Duration } from '@salesforce/kit';
 import { PackageDescriptorJson, PackageType, PackagingSObjects } from '../interfaces';
@@ -40,7 +40,7 @@ export declare function massageErrorMessage(err: Error): Error;
  * @param connection For tooling query
  */
 export declare function getPackageVersionId(versionId: string, connection: Connection): Promise<string | undefined>;
-export declare function escapeInstallationKey(key?: string): Nullable<string>;
+export declare function escapeInstallationKey(key: string): string;
 /**
  * Get the ContainerOptions for the specified Package2 (0Ho) IDs.
  *

package/lib/utils/packageUtils.js

@@ -208,7 +208,7 @@ async function getPackageVersionId(versionId, connection) {
     });
 }
 function escapeInstallationKey(key) {
-    return key ? key.replace(/\\/g, '\\\\').replace(/'/g, "\\'") : null;
+    return key.replace(/\\/g, '\\\\').replace(/'/g, "\\'");
 }
 /**
  * Get the ContainerOptions for the specified Package2 (0Ho) IDs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.1.5",
+  "version": "4.1.6",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -42,13 +42,13 @@
   ],
   "dependencies": {
     "@jsforce/jsforce-node": "^3.2.0",
-    "@salesforce/core": "^8.2.3",
+    "@salesforce/core": "^8.2.7",
     "@salesforce/kit": "^3.1.6",
     "@salesforce/schemas": "^1.9.0",
     "@salesforce/source-deploy-retrieve": "^12.1.8",
-    "@salesforce/ts-types": "^2.0.10",
+    "@salesforce/ts-types": "^2.0.11",
     "@salesforce/types": "^1.2.0",
-    "fast-xml-parser": "^4.4.0",
+    "fast-xml-parser": "^4.4.1",
     "globby": "^11",
     "graphology": "^0.25.4",
     "graphology-traversal": "^0.3.1",
@@ -57,14 +57,14 @@
     "object-treeify": "^2"
   },
   "devDependencies": {
-    "@salesforce/cli-plugins-testkit": "^5.3.18",
-    "@salesforce/dev-scripts": "^10.2.2",
+    "@salesforce/cli-plugins-testkit": "^5.3.20",
+    "@salesforce/dev-scripts": "^10.2.8",
     "@types/globby": "^9.1.0",
     "@types/jszip": "^3.4.1",
-    "eslint-plugin-sf-plugin": "^1.18.11",
+    "eslint-plugin-sf-plugin": "^1.20.1",
     "shelljs": "0.8.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.4"
   },
   "publishConfig": {
     "access": "public"