@salesforce/packaging 0.1.11 → 0.1.13

package/lib/utils/packageUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEntry = exports.getPackageAliasesFromId = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getPackageVersionNumber = exports.concatVersion = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = exports.validateIdNoThrow = exports.getSourceApiVersion = exports.validateId = exports.BY_LABEL = exports.BY_PREFIX = exports.DEFAULT_PACKAGE_DIR = exports.POLL_INTERVAL_SECONDS = exports.SOQL_WHERE_CLAUSE_MAX_LENGTH = exports.INSTALL_URL_BASE = exports.VERSION_NUMBER_SEP = void 0;
+exports.numberToDuration = exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEntry = exports.getPackageAliasesFromId = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getPackageVersionNumber = exports.concatVersion = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.escapeInstallationKey = exports.getPackageVersionId = exports.massageErrorMessage = exports.applyErrorAction = exports.validateIdNoThrow = exports.getSourceApiVersion = exports.validateId = exports.BY_LABEL = exports.BY_PREFIX = exports.DEFAULT_PACKAGE_DIR = exports.POLL_INTERVAL_SECONDS = exports.SOQL_WHERE_CLAUSE_MAX_LENGTH = exports.INSTALL_URL_BASE = exports.VERSION_NUMBER_SEP = void 0;
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -9,6 +9,8 @@ exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEnt
  */
 const os = require("os");
 const core_1 = require("@salesforce/core");
+const ts_types_1 = require("@salesforce/ts-types");
+const kit_1 = require("@salesforce/kit");
 core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'pkg_utils');
 exports.VERSION_NUMBER_SEP = '.';
@@ -96,7 +98,7 @@ function applyErrorAction(err) {
     if (err.name === 'INVALID_OR_NULL_FOR_RESTRICTED_PICKLIST') {
         actions.push(messages.getMessage('invalidPackageTypeAction'));
     }
-    if (err.name === 'MALFORMED_ID' && err.message === messages.getMessage('malformedPackageIdMessage')) {
+    if (err.name === 'MALFORMED_ID' && err.message === messages.getMessage('malformedPackageIdMessage', [''])) {
         actions.push(messages.getMessage('malformedPackageIdAction'));
     }
     if (err.name === 'MALFORMED_ID' && err.message === messages.getMessage('malformedPackageVersionIdMessage')) {
@@ -114,6 +116,24 @@ function applyErrorAction(err) {
     return err;
 }
 exports.applyErrorAction = applyErrorAction;
+function massageErrorMessage(err) {
+    if (err.name === 'INVALID_OR_NULL_FOR_RESTRICTED_PICKLIST') {
+        err['message'] = messages.getMessage('invalidPackageTypeMessage');
+    }
+    if (err.name === 'MALFORMED_ID' &&
+        (err.message.includes('Version ID') || err.message.includes('Version Definition ID'))) {
+        err['message'] = messages.getMessage('malformedPackageVersionIdMessage');
+    }
+    if (err.name === 'MALFORMED_ID' && err.message.includes('Package2 ID')) {
+        err['message'] = messages.getMessage('malformedPackageIdMessage');
+    }
+    // remove references to Second Generation
+    if (err.message.includes('Second Generation ')) {
+        err['message'] = err.message.replace('Second Generation ', '');
+    }
+    return err;
+}
+exports.massageErrorMessage = massageErrorMessage;
 /**
  * Given a subscriber package version ID (04t) or package version ID (05i), return the package version ID (05i)
  *
@@ -142,22 +162,6 @@ function escapeInstallationKey(key) {
     return key ? key.replace(/\\/g, '\\\\').replace(/'/g, "\\'") : null;
 }
 exports.escapeInstallationKey = escapeInstallationKey;
-/**
- * Given 0Ho the package type type (Managed, Unlocked, Locked(deprecated?))
- *
- * @param packageId the 0Ho
- * @param connection For tooling query
- * @throws Error with message when package2 cannot be found
- */
-async function getPackageType(packageId, connection) {
-    const query = `SELECT ContainerOptions FROM Package2 WHERE id ='${packageId}'`;
-    const queryResult = await connection.tooling.query(query);
-    if (queryResult.records.length === 0) {
-        throw messages.createError('errorInvalidPackageId', [packageId]);
-    }
-    return queryResult.records[0].ContainerOptions;
-}
-exports.getPackageType = getPackageType;
 /**
  * Get the ContainerOptions for the specified Package2 (0Ho) IDs.
  *
@@ -344,13 +348,11 @@ exports.getPackageAliasesFromId = getPackageAliasesFromId;
  * @param packageId the 0Ho id
  * @private
  */
-// TODO: SfProjectJson.addPackageAlias
+// TODO: move sfProject
 async function generatePackageAliasEntry(connection, project, packageVersionId, packageVersionNumber, branch, packageId) {
-    const configContent = project.getSfProjectJson().getContents();
-    const packageAliases = configContent.packageAliases || {};
     const aliasForPackageId = getPackageAliasesFromId(packageId, project);
     let packageName;
-    if (!aliasForPackageId || aliasForPackageId.length === 0) {
+    if (aliasForPackageId?.length === 0) {
         const query = `SELECT Name FROM Package2 WHERE Id = '${packageId}'`;
         const package2 = await connection.singleRecordQuery(query, { tooling: true });
         packageName = package2.Name;
@@ -361,8 +363,7 @@ async function generatePackageAliasEntry(connection, project, packageVersionId,
     const packageAlias = branch
         ? `${packageName}@${packageVersionNumber}-${branch}`
         : `${packageName}@${packageVersionNumber}`;
-    packageAliases[packageAlias] = packageVersionId;
-    return packageAliases;
+    return [packageAlias, packageVersionId];
 }
 exports.generatePackageAliasEntry = generatePackageAliasEntry;
 function formatDate(date) {
@@ -380,4 +381,14 @@ function combineSaveErrors(sObject, crudOperation, errors) {
     return messages.createError('errorDuringSObjectCRUDOperation', [crudOperation, sObject, errorMessages.join(os.EOL)]);
 }
 exports.combineSaveErrors = combineSaveErrors;
+/**
+ * Returns a Duration object from param duration when it is a number, otherwise return itself
+ *
+ * @param duration = number to be converted to a Duration or Duration object
+ * @param unit = (Default Duration.Unit.MILLISECONDS) Duration unit of number - See @link {Duration.Unit} for valid values
+ */
+function numberToDuration(duration, unit = kit_1.Duration.Unit.MILLISECONDS) {
+    return (0, ts_types_1.isNumber)(duration) ? new kit_1.Duration(duration, unit) : duration;
+}
+exports.numberToDuration = numberToDuration;
 //# sourceMappingURL=packageUtils.js.map

package/messages/package.md

@@ -1,10 +1,10 @@
 # invalidPackageId
 
-The %s: [%s] is invalid. It must start with "%s".
+The id [%s] is invalid. It must start with "%s".
 
 # invalidIdLength
 
-The %s: [%s] is invalid. It must be either 15 or 18 characters.
+The id [%s] is invalid. It must be either 15 or 18 characters.
 
 # defaultErrorMessage
 
@@ -13,3 +13,19 @@ Can't uninstall the package %s during uninstall request %s.
 # action
 
 Verify installed package ID and resolve errors, then try again.
+
+# couldNotFindAliasForId
+
+Could not find an alias for the ID %s.
+
+# packageAliasNotFound
+
+Package alias %s not found in project.
+
+# noPackageAliases
+
+The project doesn't have any package aliases.
+
+# package2VersionNotFoundFor04t
+
+Could not find a Package2Version record for SubscriberPackageVersionId %s.

package/messages/package_version.md

@@ -5,3 +5,15 @@ The %s %s is invalid, as a corresponding %s was not found
 # errorInvalidPackageVersionId
 
 The provided alias or ID: [%s] could not be resolved to a valid package version ID (05i) or subscriber package version ID (04t).
+
+# packageVersionInstallRequestIdInvalid
+
+The provided package install request ID: [%s] is invalid. It must be a 15 or 18 character package install request ID (0Hf).
+
+# packageVersionUninstallRequestIdInvalid
+
+The provided package uninstall request ID: [%s] is invalid. It must be a 15 or 18 character package install request ID (06y).
+
+# packageVersionInstallRequestNotFound
+
+The provided package install request ID: [%s] could not be found.

package/messages/pkg_utils.md

@@ -3,34 +3,6 @@
 An error occurred during CRUD operation %s on entity %s.
 %s
 
-# errorInvalidPatchNumber
-
-The provided VersionNumber '%s' is not supported. Provide a patch number of 0.
-
-# errorInvalidAncestorVersionFormat
-
-The ancestor versionNumber must be in the format major.minor.patch but the value found is [%s].
-
-# errorNoMatchingMajorMinorForPatch
-
-Can’t create patch version. The specified package ancestor [%s] either isn’t a promoted and released version, or can’t be found. Check the specified ancestor version, and then retry creating the patch version.
-
-# errorNoMatchingAncestor
-
-The ancestorId for ancestorVersion [%s] can't be found. Package ID [%s].
-
-# errorAncestorNotReleased
-
-The ancestor package version [%s] specified in the sfdx-project.json file hasn’t been promoted and released. Release the ancestor package version before specifying it as the ancestor in a new package or patch version.
-
-# errorAncestorIdVersionMismatch
-
-Can’t create package version. The ancestorVersion listed in your sfdx-project.json file doesn’t map to this package. Ensure the ancestor ID is correct, or set the ID to ancestorID:HIGHEST to ensure the highest released package version is used as the ancestor. Then try creating the package version again.
-
-# errorAncestorIdVersionHighestOrNoneMismatch
-
-Can’t create package version. The ancestorId [%s] and ancestorVersion [%s] in your sfdx-project.json file don’t map to the same package version. Remove the incorrect entry, and try creating the package version again.
-
 # errorInvalidIdNoMatchingVersionId
 
 The %s %s is invalid, as a corresponding %s was not found
@@ -61,16 +33,12 @@ Use "sfdx force:package:list" to verify the 0Ho package version ID.
 
 # malformedPackageIdMessage
 
-We can’t find this package ID for this Dev Hub.
+We can’t find this package ID %s for this Dev Hub.
 
 # notFoundMessage
 
 The requested resource does not exist
 
-# versionCreateFailedWithMultipleErrors
-
-Multiple errors occurred:
-
 # itemDoesNotFitWithinMaxLength
 
 When calculating the number of items to be included in query "%s", when formatted, was too long.
@@ -91,3 +59,7 @@ Your Dev Hub does not have permission to specify a source org for your build org
 # invalidIdOrAlias
 
 The %s: %s isn't defined in the sfdx-project.json. Add it to the packageDirectories section and add the alias to packageAliases with its %s ID.
+
+# errorInvalidPackageId
+
+The provided package ID '%s' is invalid.

package/messages/subscriber_package_version.md

@@ -0,0 +1,19 @@
+# errorInvalidIdNoRecordFound
+
+The subscriber package version %s is invalid, no subscriber package version record found.
+
+# errorInvalidAliasOrId
+
+Invalid alias or ID: %s. Either your alias is invalid or undefined, or the ID (04t) provided is invalid.
+
+# packageVersionInstallRequestIdInvalid
+
+The provided package install request ID: [%s] is invalid. It must be a 15 or 18 character package install request ID (0Hf).
+
+# packageVersionUninstallRequestIdInvalid
+
+The provided package uninstall request ID: [%s] is invalid. It must be a 15 or 18 character package install request ID (06y).
+
+# packageVersionInstallRequestNotFound
+
+The provided package install request ID: [%s] could not be found.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -64,11 +64,11 @@
     "@types/globby": "^9.1.0",
     "@types/jszip": "^3.4.1",
     "@types/xml2js": "^0.4.11",
-    "@typescript-eslint/eslint-plugin": "^5.40.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.1",
     "@typescript-eslint/parser": "5.40.1",
     "chai": "^4.3.6",
     "commitizen": "^4.2.4",
-    "eslint": "^8.24.0",
+    "eslint": "^8.26.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-salesforce": "^0.1.6",
     "eslint-config-salesforce-license": "^0.1.6",

package/lib/package/packageList.d.ts

@@ -1,4 +0,0 @@
-import { Connection } from '@salesforce/core';
-import { QueryResult } from 'jsforce';
-import { PackagingSObjects } from '../interfaces';
-export declare function listPackages(connection: Connection): Promise<QueryResult<PackagingSObjects.Package2>>;

package/lib/package/packageList.js

@@ -1,19 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2022, salesforce.com, inc.
- * All rights reserved.
- * Licensed under the BSD 3-Clause license.
- * 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.listPackages = void 0;
-const QUERY = 'SELECT Id, SubscriberPackageId, Name, Description, NamespacePrefix, ContainerOptions, IsOrgDependent, ConvertedFromPackageId, ' +
-    'PackageErrorUsername, CreatedById ' +
-    'FROM Package2 ' +
-    'WHERE IsDeprecated != true ' +
-    'ORDER BY NamespacePrefix, Name';
-async function listPackages(connection) {
-    return connection.tooling.query(QUERY);
-}
-exports.listPackages = listPackages;
-//# sourceMappingURL=packageList.js.map