@salesforce/packaging 0.1.1 → 0.1.3

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -227,6 +227,7 @@ export declare type PackageVersionCreateOptions = {
     installationkey: string;
     installationkeybypass: boolean;
     packageId: string;
+    path: string;
     postinstallscript: string;
     postinstallurl: string;
     preserve: boolean;

package/lib/package/packageVersionCreate.d.ts

@@ -7,7 +7,7 @@ export declare class PackageVersionCreate {
     private packageObject;
     private packageType;
     private packageId;
-    private packageAlias;
+    private readonly logger;
     constructor(options: PackageVersionCreateOptions);
     createPackageVersion(): Promise<Partial<PackageVersionCreateRequestResult>>;
     private generateMDFolderForArtifact;

package/lib/package/packageVersionCreate.js

@@ -23,13 +23,13 @@ const packageProfileApi_1 = require("./packageProfileApi");
 const packageVersionCreateRequest_1 = require("./packageVersionCreateRequest");
 core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'package_version_create');
-const logger = core_1.Logger.childFromRoot('packageVersionCreate');
 const DESCRIPTOR_FILE = 'package2-descriptor.json';
 class PackageVersionCreate {
     constructor(options) {
         this.options = options;
         this.connection = this.options.connection;
         this.project = this.options.project;
+        this.logger = core_1.Logger.childFromRoot('packageVersionCreate');
     }
     createPackageVersion() {
         try {
@@ -145,7 +145,7 @@ class PackageVersionCreate {
         if (versionNumber.isbuildKeyword()) {
             versionNumber.build = resolvedBuildNumber;
             if (buildNumber === utils_1.BuildNumberToken.LATEST_BUILD_NUMBER_TOKEN) {
-                logger.info(messages.getMessage('buildNumberResolvedForLatest', [
+                this.logger.info(messages.getMessage('buildNumberResolvedForLatest', [
                     dependency.package,
                     versionNumber.toString(),
                     branchString,
@@ -153,7 +153,7 @@ class PackageVersionCreate {
                 ]));
             }
             else if (buildNumber === utils_1.BuildNumberToken.RELEASED_BUILD_NUMBER_TOKEN) {
-                logger.info(messages.getMessage('buildNumberResolvedForReleased', [
+                this.logger.info(messages.getMessage('buildNumberResolvedForReleased', [
                     dependency.package,
                     versionNumber.toString(),
                     dependency.subscriberPackageVersionId,
@@ -214,7 +214,7 @@ class PackageVersionCreate {
                 location: packageVersTmpRoot,
                 message,
             });
-            logger.info(message);
+            this.logger.info(message);
             return requestObject;
         }
         else {
@@ -344,11 +344,11 @@ class PackageVersionCreate {
         // Log information about the profiles being packaged up
         const profiles = this.options.profileApi.getProfileInformation();
         profiles.forEach((profile) => {
-            if (logger.shouldLog(core_1.LoggerLevel.DEBUG)) {
-                logger.debug(profile.logDebug());
+            if (this.logger.shouldLog(core_1.LoggerLevel.DEBUG)) {
+                this.logger.debug(profile.logDebug());
             }
-            else if (logger.shouldLog(core_1.LoggerLevel.INFO)) {
-                logger.info(profile.logInfo());
+            else if (this.logger.shouldLog(core_1.LoggerLevel.INFO)) {
+                this.logger.info(profile.logInfo());
             }
         });
         await fs.promises.writeFile(path.join(packageVersMetadataFolder, 'package.xml'), xml, 'utf-8');
@@ -419,13 +419,29 @@ class PackageVersionCreate {
         if (this.project.getPackageDirectories()?.length === 0) {
             throw messages.createError('errorEmptyPackageDirs');
         }
-        // from the packageDirectories in sfdx-project.json, find the correct package entry either by finding a matching package (name) or path
-        this.packageAlias = (0, utils_2.getPackageAliasesFromId)(this.options.packageId, this.options.project).join();
-        this.packageId = this.options.packageId;
-        // set on the class, so we can access them in other methods without redoing this logic
-        this.packageObject = this.project
-            .getPackageDirectories()
-            .find((pkg) => pkg.package === this.packageAlias || pkg['id'] === this.options.packageId);
+        // either options.packageId or options.path is required
+        if (!this.options.packageId && !this.options.path) {
+            throw messages.createError('errorMissingPackageIdOrPath');
+        }
+        // establish the package Id (0ho) and load the package directory
+        let packageName;
+        if (this.options.packageId) {
+            const pkg = this.options.packageId;
+            packageName = pkg.startsWith('0Ho')
+                ? this.project.getAliasesFromPackageId(pkg).find((alias) => alias)
+                : this.project.getPackageIdFromAlias(pkg);
+            if (!packageName)
+                throw messages.createError('errorMissingPackage', [this.options.packageId]);
+            this.packageObject = this.project.findPackage((pkg) => pkg.package === packageName || pkg.name === packageName);
+        }
+        else {
+            // due to flag validation, we'll either have a package or path flag
+            this.packageObject = this.project.getPackageFromPath(this.options.path);
+            packageName = this.packageObject?.package;
+            if (!packageName)
+                throw messages.createError('errorCouldNotFindPackageUsingPath', [this.options.path]);
+        }
+        this.packageId = this.project.getPackageIdFromAlias(packageName) || packageName;
         this.options.profileApi = await this.resolveUserLicenses(this.packageObject.includeProfileUserLicenses);
         // At this point, the packageIdFromAlias should have been resolved to an Id.  Now, we
         // need to validate that the Id is correct.
@@ -443,7 +459,7 @@ class PackageVersionCreate {
         return (await (0, packageVersionCreateRequest_1.byId)(createResult.id, this.connection))[0];
     }
     async resolveUserLicenses(includeUserLicenses) {
-        const shouldGenerateProfileInformation = logger.shouldLog(core_1.LoggerLevel.INFO) || logger.shouldLog(core_1.LoggerLevel.DEBUG);
+        const shouldGenerateProfileInformation = this.logger.shouldLog(core_1.LoggerLevel.INFO) || this.logger.shouldLog(core_1.LoggerLevel.DEBUG);
         return await packageProfileApi_1.PackageProfileApi.create({
             project: this.project,
             includeUserLicenses,
@@ -496,7 +512,7 @@ class PackageVersionCreate {
                 versionNumber.split(pkgUtils.VERSION_NUMBER_SEP)[3] === utils_1.BuildNumberToken.NEXT_BUILD_NUMBER_TOKEN
                     ? versionNumber.substring(0, versionNumber.indexOf(pkgUtils.VERSION_NUMBER_SEP + utils_1.BuildNumberToken.NEXT_BUILD_NUMBER_TOKEN))
                     : versionNumber;
-            logger.warn(options, messages.getMessage('defaultVersionName', [packageDescriptorJson.versionName]));
+            this.logger.warn(options, messages.getMessage('defaultVersionName', [packageDescriptorJson.versionName]));
         }
         if (options.releasenotesurl) {
             packageDescriptorJson.releaseNotesUrl = options.releasenotesurl;

package/lib/package/packageVersionList.js

@@ -23,7 +23,13 @@ const VERBOSE_SELECT = 'SELECT Id, Package2Id, SubscriberPackageVersionId, Name,
     'ConvertedFromVersionId, Package2.IsOrgDependent, ReleaseVersion, BuildDurationInSeconds, HasMetadataRemoved, CreatedById ' +
     'FROM Package2Version';
 exports.DEFAULT_ORDER_BY_FIELDS = 'Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber';
-const logger = core_1.Logger.childFromRoot('packageVersionList');
+let logger;
+const getLogger = () => {
+    if (!logger) {
+        logger = core_1.Logger.childFromRoot('packageVersionList');
+    }
+    return logger;
+};
 async function listPackageVersions(options) {
     return options.connection.tooling.query(constructQuery(options));
 }
@@ -38,7 +44,7 @@ function assembleQueryParts(select, where, orderBy) {
     const orderByPart = `ORDER BY ${orderBy ? orderBy : exports.DEFAULT_ORDER_BY_FIELDS}`;
     const wherePart = where.length > 0 ? `WHERE ${where.join(' AND ')}` : '';
     const query = `${select} ${wherePart} ${orderByPart}`;
-    logger.debug(query);
+    getLogger().debug(query);
     return query;
 }
 exports.assembleQueryParts = assembleQueryParts;

package/lib/package/packageVersionReport.js

@@ -26,7 +26,13 @@ const QUERY_VERBOSE = 'SELECT Id, Package2Id, SubscriberPackageVersionId, Name,
     'FROM Package2Version ' +
     "WHERE Id = '%s' AND IsDeprecated != true " +
     'ORDER BY Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber';
-const logger = core_1.Logger.childFromRoot('getPackageVersionReport');
+let logger;
+const getLogger = () => {
+    if (!logger) {
+        logger = core_1.Logger.childFromRoot('getPackageVersionReport');
+    }
+    return logger;
+};
 /**
  * Given a list of subscriber package version IDs (04t), return the associated version strings (e.g., Major.Minor.Patch.Build)
  *
@@ -54,7 +60,7 @@ async function getPackageVersionStrings(subscriberPackageVersionIds, connection)
     return results;
 }
 async function getPackageVersionReport(options) {
-    logger.debug(`entering getPackageVersionReport(${util.inspect(options, { depth: null })})`);
+    getLogger().debug(`entering getPackageVersionReport(${util.inspect(options, { depth: null })})`);
     const queryResult = await options.connection.tooling.query(util.format(options.verbose ? QUERY_VERBOSE : QUERY, options.packageVersionId));
     const records = queryResult.records;
     if (records?.length > 0) {

package/messages/package_version_create.md

@@ -106,3 +106,15 @@ No subscriber package was found for seed id: %s
 
 Only one package in a Dev Hub is allowed per converted from first-generation package, but the following were found:
 %s
+
+# errorMissingPackageIdOrPath
+
+You must specify either a package ID or a package path to create a new package version.
+
+# errorMissingPackage
+
+The package "%s" isn’t defined in the sfdx-project.json file. Add it to the packageDirectories section and add the alias to packageAliases with its 0Ho ID.
+
+# errorCouldNotFindPackageUsingPath
+
+Could not find a package in sfdx-project.json file using "path" %s. Add it to the packageDirectories section and add the alias to packageAliases with its 0Ho ID.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -20,7 +20,7 @@
     "prepare": "sf-install",
     "pretest": "sf-compile-test",
     "test": "sf-test",
-    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel"
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 1800000 --parallel"
   },
   "keywords": [
     "force",
@@ -36,10 +36,10 @@
   ],
   "dependencies": {
     "@oclif/core": "^1.18.0",
-    "@salesforce/core": "^3.31.10",
+    "@salesforce/core": "^3.31.11",
     "@salesforce/kit": "^1.7.0",
     "@salesforce/schemas": "^1.1.3",
-    "@salesforce/source-deploy-retrieve": "^6.9.1",
+    "@salesforce/source-deploy-retrieve": "^6.10.0",
     "@salesforce/ts-types": "^1.5.21",
     "@xmldom/xmldom": "^0.8.3",
     "debug": "^4.3.4",
@@ -48,7 +48,7 @@
     "graphology-traversal": "^0.3.1",
     "graphology-types": "^0.24.4",
     "js2xmlparser": "^4.0.2",
-    "jsforce": "beta",
+    "jsforce": "2.0.0-beta.19",
     "jszip": "^3.10.1",
     "mkdirp": "1.0.4",
     "ts-retry-promise": "^0.7.0",
@@ -64,8 +64,8 @@
     "@types/globby": "^9.1.0",
     "@types/jszip": "^3.4.1",
     "@types/xml2js": "^0.4.11",
-    "@typescript-eslint/eslint-plugin": "^5.39.0",
-    "@typescript-eslint/parser": "5.38.1",
+    "@typescript-eslint/eslint-plugin": "^5.40.0",
+    "@typescript-eslint/parser": "5.40.0",
     "chai": "^4.3.6",
     "commitizen": "^4.2.4",
     "eslint": "^8.24.0",