@salesforce/packaging 0.0.6 → 0.0.7

package/lib/utils/packageUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveCanonicalPackageProperty = exports.combineSaveErrors = exports.formatDate = exports.getSoqlWhereClauseMaxLength = exports.pollForStatusWithInterval = exports.findOrCreatePackage2 = exports.getPackageAliasesFromId = exports.convertCamelCaseStringToSentence = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getConfigPackageDirectories = exports.getPackage2VersionNumber = exports.concatVersion = exports.getAncestorIdHighestRelease = exports.validateAncestorId = exports.getAncestorId = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getSubscriberPackageVersionId = exports.getPackage2TypeBy04t = exports.getPackage2Type = exports.getPackageVersionId = exports.applyErrorAction = exports.massageErrorMessage = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.validUrl = exports.validatePatchVersion = exports.validateVersionNumber = exports.validateIdNoThrow = 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.resolveCanonicalPackageProperty = exports.combineSaveErrors = exports.formatDate = exports.getSoqlWhereClauseMaxLength = exports.pollForStatusWithInterval = exports.findOrCreatePackage = exports.getPackageAliasesFromId = exports.convertCamelCaseStringToSentence = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getConfigPackageDirectories = exports.getPackageVersionNumber = exports.concatVersion = exports.getAncestorIdHighestRelease = exports.validateAncestorId = exports.getAncestorId = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getSubscriberPackageVersionId = exports.getPackageTypeBy04t = exports.getPackageType = exports.getPackageVersionId = exports.applyErrorAction = exports.massageErrorMessage = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.validUrl = exports.validatePatchVersion = exports.validateVersionNumber = exports.validateIdNoThrow = 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.
@@ -214,40 +214,40 @@ exports.getPackageVersionId = getPackageVersionId;
 /**
  * Given 0Ho the package type type (Managed, Unlocked, Locked(deprecated?))
  *
- * @param package2Id the 0Ho
+ * @param packageId the 0Ho
  * @param connection For tooling query
  * @throws Error with message when package2 cannot be found
  */
-async function getPackage2Type(package2Id, connection) {
-    const query = `SELECT ContainerOptions FROM Package2 WHERE id ='${package2Id}'`;
+async function getPackageType(packageId, connection) {
+    const query = `SELECT ContainerOptions FROM Package2 WHERE id ='${packageId}'`;
     const queryResult = await connection.tooling.query(query);
     if (!queryResult || queryResult.records === null || queryResult.records.length === 0) {
-        throw messages.createError('errorInvalidPackageId', [package2Id]);
+        throw messages.createError('errorInvalidPackageId', [packageId]);
     }
     return queryResult.records[0].ContainerOptions;
 }
-exports.getPackage2Type = getPackage2Type;
+exports.getPackageType = getPackageType;
 /**
  * Given 04t the package type type (Managed, Unlocked, Locked(deprecated?))
  *
- * @param package2VersionId the 04t
+ * @param packageVersionId the 04t
  * @param connection For tooling query
  * @param installKey For tooling query, if an installation key is applicable to the package version it must be passed in the queries
  * @throws Error with message when package2 cannot be found
  */
-async function getPackage2TypeBy04t(package2VersionId, connection, installKey) {
-    let query = `SELECT Package2ContainerOptions FROM SubscriberPackageVersion WHERE id ='${package2VersionId}'`;
+async function getPackageTypeBy04t(packageVersionId, connection, installKey) {
+    let query = `SELECT Package2ContainerOptions FROM SubscriberPackageVersion WHERE id ='${packageVersionId}'`;
     if (installKey) {
         const escapedInstallationKey = installKey.replace(/\\/g, '\\\\').replace(/'/g, "\\'");
         query += ` AND InstallationKey ='${escapedInstallationKey}'`;
     }
     const queryResult = await connection.tooling.query(query);
     if (!queryResult || queryResult.records === null || queryResult.records.length === 0) {
-        throw messages.createError('errorInvalidPackageId', [package2VersionId]);
+        throw messages.createError('errorInvalidPackageId', [packageVersionId]);
     }
     return queryResult.records[0].Package2ContainerOptions;
 }
-exports.getPackage2TypeBy04t = getPackage2TypeBy04t;
+exports.getPackageTypeBy04t = getPackageTypeBy04t;
 /**
  * Given a package version ID (05i) or subscriber package version ID (04t), return the subscriber package version ID (04t)
  *
@@ -275,16 +275,16 @@ exports.getSubscriberPackageVersionId = getSubscriberPackageVersionId;
  * Get the ContainerOptions for the specified Package2 (0Ho) IDs.
  *
  * @return Map of 0Ho id to container option api value
- * @param package2Ids The list of package IDs
+ * @param packageIds The list of package IDs
  * @param connection For tooling query
  */
 // eslint-disable-next-line @typescript-eslint/require-await
-async function getContainerOptions(package2Ids, connection) {
-    if (!package2Ids || package2Ids.length === 0) {
+async function getContainerOptions(packageIds, connection) {
+    if (!packageIds || packageIds.length === 0) {
         return new Map();
     }
     const query = "SELECT Id, ContainerOptions FROM Package2 WHERE Id IN ('%IDS%')";
-    const records = await queryWithInConditionChunking(query, package2Ids, '%IDS%', connection);
+    const records = await queryWithInConditionChunking(query, packageIds, '%IDS%', connection);
     if (records && records.length > 0) {
         return new Map(records.map((record) => [record.Id, record.ContainerOptions]));
     }
@@ -414,7 +414,7 @@ async function getAncestorId(packageDescriptorJson, connection, project, version
         // If an id property is present, use it.  Otherwise, look up the package id from the package property.
         const packageId = (_a = packageDescriptorJson['id']) !== null && _a !== void 0 ? _a : getPackageIdFromAlias(packageDescriptorJson.package, project);
         // No need to proceed if Unlocked
-        const packageType = await getPackage2Type(packageId, connection);
+        const packageType = await getPackageType(packageId, connection);
         if (packageType === 'Unlocked') {
             return '';
         }
@@ -505,7 +505,7 @@ function validateAncestorId(ancestorId, highestReleasedVersion, explicitUseNoAnc
         }
         else {
             // the explicitUseNoAncestor && skipAncestorCheck case is handled above
-            throw messages.createError('errorAncestorNoneNotAllowed', [getPackage2VersionNumber(highestReleasedVersion)]);
+            throw messages.createError('errorAncestorNoneNotAllowed', [getPackageVersionNumber(highestReleasedVersion)]);
         }
     }
     if (!isPatch && !skipAncestorCheck) {
@@ -513,7 +513,7 @@ function validateAncestorId(ancestorId, highestReleasedVersion, explicitUseNoAnc
             if (highestReleasedVersion.Id !== ancestorId) {
                 throw messages.createError('errorAncestorNotHighest', [
                     origSpecifiedAncestor,
-                    getPackage2VersionNumber(highestReleasedVersion),
+                    getPackageVersionNumber(highestReleasedVersion),
                 ]);
             }
         }
@@ -563,7 +563,7 @@ async function getAncestorIdHighestRelease(connection, packageId, versionNumberS
         }
         else if (explicitUseHighestRelease) {
             // there is no eligible ancestor version
-            throw new Error(messages.getMessage('errorNoMatchingAncestor', [versionNumberString, packageId]));
+            throw messages.createError('errorNoMatchingAncestor', [versionNumberString, packageId]);
         }
     }
     return result;
@@ -576,11 +576,11 @@ function concatVersion(major, minor, patch, build) {
     return [major, minor, patch, build].map((part) => (part ? `${part}` : '0')).join('.');
 }
 exports.concatVersion = concatVersion;
-function getPackage2VersionNumber(package2VersionObj) {
+function getPackageVersionNumber(package2VersionObj) {
     const version = concatVersion(package2VersionObj.MajorVersion, package2VersionObj.MinorVersion, package2VersionObj.PatchVersion, undefined);
     return version.slice(0, version.lastIndexOf('.'));
 }
-exports.getPackage2VersionNumber = getPackage2VersionNumber;
+exports.getPackageVersionNumber = getPackageVersionNumber;
 // TODO: get rid of this function if possible.
 function getConfigPackageDirectories(project) {
     return project.getPackageDirectories();
@@ -627,13 +627,13 @@ function getPackageAliasesFromId(packageId, project) {
 }
 exports.getPackageAliasesFromId = getPackageAliasesFromId;
 // probably used by convert.
-async function findOrCreatePackage2(seedPackage, connection) {
+async function findOrCreatePackage(seedPackage, connection) {
     const query = `SELECT Id FROM Package2 WHERE ConvertedFromPackageId = '${seedPackage}'`;
     const queryResult = await connection.tooling.query(query);
     const records = queryResult.records;
     if (records && records.length > 1) {
         const ids = records.map((r) => r.Id);
-        throw new Error(messages.getMessage('errorMoreThanOnePackage2WithSeed', [ids.join(', ')]));
+        throw messages.createError('errorMoreThanOnePackage2WithSeed', [ids.join(', ')]);
     }
     if (records && records.length === 1) {
         // return the package2 object
@@ -644,7 +644,7 @@ async function findOrCreatePackage2(seedPackage, connection) {
     const subscriberResult = await connection.tooling.query(subQuery);
     const subscriberRecords = subscriberResult.records;
     if (!subscriberRecords || subscriberRecords.length <= 0) {
-        throw new Error(messages.getMessage('errorNoSubscriberPackageRecord', [seedPackage]));
+        throw messages.createError('errorNoSubscriberPackageRecord', [seedPackage]);
     }
     const request = {
         Name: subscriberRecords[0].Name,
@@ -659,7 +659,7 @@ async function findOrCreatePackage2(seedPackage, connection) {
     }
     return createResult.id;
 }
-exports.findOrCreatePackage2 = findOrCreatePackage2;
+exports.findOrCreatePackage = findOrCreatePackage;
 async function pollForStatusWithInterval(id, retries, packageId, branch, withProject, connection, interval) {
     let remainingRetries = retries;
     const pollingClient = await core_1.PollingClient.create({
@@ -674,19 +674,19 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, withPro
                     if (withProject && !process.env.SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE) {
                         projectUpdated = true;
                         const query = `SELECT MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE Id = '${results[0].Package2VersionId}'`;
-                        const package2VersionVersionString = await connection.tooling
+                        const packageVersionVersionString = await connection.tooling
                             .query(query)
                             .then((pkgQueryResult) => {
                             const record = pkgQueryResult.records[0];
                             return `${record.MajorVersion}.${record.MinorVersion}.${record.PatchVersion}-${record.BuildNumber}`;
                         });
-                        const newConfig = await _generatePackageAliasEntry(connection, withProject, results[0].SubscriberPackageVersionId, package2VersionVersionString, branch, packageId);
+                        const newConfig = await _generatePackageAliasEntry(connection, withProject, results[0].SubscriberPackageVersionId, packageVersionVersionString, branch, packageId);
                         withProject.getSfProjectJson().set('packageAliases', newConfig);
                         await withProject.getSfProjectJson().write();
                     }
                     core_1.Lifecycle.getInstance().emit(Package2VersionStatus.success, {
                         id,
-                        package2VersionCreateRequestResult: results[0],
+                        packageVersionCreateRequestResult: results[0],
                         projectUpdated,
                     });
                     return { completed: true, payload: results[0] };
@@ -712,7 +712,7 @@ async function pollForStatusWithInterval(id, retries, packageId, branch, withPro
                 const remainingTime = kit_1.Duration.milliseconds(interval.milliseconds * remainingRetries);
                 core_1.Lifecycle.getInstance().emit(Package2VersionStatus.inProgress, {
                     id,
-                    package2VersionCreateRequestResult: results[0],
+                    packageVersionCreateRequestResult: results[0],
                     message: '',
                     remainingTime,
                 });

package/lib/utils/srcDevUtils.js

@@ -7,12 +7,14 @@ exports.copyDir = exports.getElapsedTime = exports.zipDir = void 0;
  * 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
  */
-const path = require("path");
-const os = require("os");
 const fs = require("fs");
 const path_1 = require("path");
-const archiver = require("archiver");
+const stream_1 = require("stream");
+const util_1 = require("util");
 const core_1 = require("@salesforce/core");
+const globby = require("globby");
+const JSZIP = require("jszip");
+const pipeline = (0, util_1.promisify)(stream_1.pipeline);
 /**
  * Zips directory to given zipfile.
  *
@@ -24,24 +26,26 @@ const core_1 = require("@salesforce/core");
  */
 async function zipDir(dir, zipfile, options = {}) {
     const logger = core_1.Logger.childFromRoot('srcDevUtils#zipDir');
-    const file = path.parse(dir);
-    const outFile = zipfile || path.join(os.tmpdir() || '.', `${file.base}.zip`);
-    const output = fs.createWriteStream(outFile);
     const timer = process.hrtime();
-    const archive = archiver('zip', options);
-    archive.on('finish', () => {
-        logger.debug(`${archive.pointer()} bytes written to ${outFile} using ${getElapsedTime(timer)}ms`);
-        // zip file returned once stream is closed, see 'close' listener below
+    const globbyResult = await globby('**/*', { expandDirectories: true, cwd: dir });
+    const zip = new JSZIP();
+    // add files tp zip
+    for (const file of globbyResult) {
+        zip.file(file, fs.readFileSync((0, path_1.join)(dir, file)));
+    }
+    // write zip to file
+    const zipStream = zip.generateNodeStream({
+        type: 'nodebuffer',
+        streamFiles: true,
+        compression: 'DEFLATE',
+        compressionOptions: {
+            level: 3,
+        },
     });
-    archive.on('error', (err) => {
-        Promise.reject(err);
-    });
-    output.on('close', () => {
-        Promise.resolve(outFile);
-    });
-    archive.pipe(output);
-    archive.directory(dir, '');
-    return await archive.finalize();
+    await pipeline(zipStream, fs.createWriteStream(zipfile));
+    const stat = fs.statSync(zipfile);
+    logger.debug(`${stat.size} bytes written to ${zipfile} in ${getElapsedTime(timer)}ms`);
+    return;
 }
 exports.zipDir = zipDir;
 function getElapsedTime(timer) {

package/lib/utils/versionNumber.js

@@ -27,24 +27,24 @@ class VersionNumber {
     }
     static from(versionString) {
         if (!versionString) {
-            throw new Error(messages.getMessage('errorMissingVersionNumber'));
+            throw messages.createError('errorMissingVersionNumber');
         }
         const version = versionString.split('.');
         if ((version === null || version === void 0 ? void 0 : version.length) === 4) {
             const [major, minor, patch, build] = version;
             const asNumbers = [major, minor, patch, build].map((v) => parseInt(v, 10));
             if (asNumbers.slice(0, 3).some((v) => isNaN(v))) {
-                throw new Error(messages.getMessage('errorInvalidMajorMinorPatchNumber', [versionString]));
+                throw messages.createError('errorInvalidMajorMinorPatchNumber', [versionString]);
             }
             if (isNaN(asNumbers[3]) && !Object.values(BuildNumberToken).includes(build)) {
-                throw new Error(messages.getMessage('errorInvalidBuildNumberToken', [
+                throw messages.createError('errorInvalidBuildNumberToken', [
                     versionString,
                     Object.values(BuildNumberToken).join(', '),
-                ]));
+                ]);
             }
             return new VersionNumber(major, minor, patch, build);
         }
-        throw new Error(messages.getMessage('errorInvalidVersionNumber', [versionString]));
+        throw messages.createError('errorInvalidVersionNumber', [versionString]);
     }
     toString() {
         {

package/messages/messages.md

@@ -206,3 +206,35 @@ The %s value [%s], doesn’t match the %s value in any packageDirectories specif
 # errorDirectoryIdMismatch
 
 The %s value, [%s], and %s value, [%s], were both found in sfdx-project.json but don’t match. If you supply both values, they must match the path and package values in one of the packageDirectories.,
+
+# tempFileLocation
+
+The temp files are located at: %s.
+
+# failedToCreatePVCRequest
+
+Failed to create request %s: %s
+
+# versionNumberNotFoundInDevHub
+
+No version number was found in Dev Hub for package id %s and branch %s and version number %s that resolved to build number %s.
+
+# noReleaseVersionFound
+
+No released version was found in Dev Hub for package id %s and version number %s.
+
+# noReleaseVersionFoundForBranch
+
+No version number was found in Dev Hub for package id $s and branch %s and version number %s.
+
+# packagingDirNotFoundInConfigFile
+
+Config file %s does not contain a packaging directory for %s.
+
+# unpackagedMDDirectoryDoesNotExist
+
+Un-packaged metadata directory %s was specified but does not exist.
+
+# directoryDoesNotExist
+
+Directory %s does not exist.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -35,23 +35,16 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/core": "^3.23.4",
+    "@salesforce/core": "^3.23.7",
     "@salesforce/kit": "^1.5.42",
     "@salesforce/schemas": "^1.2.0",
     "@salesforce/source-deploy-retrieve": "^6.2.0",
     "@salesforce/ts-types": "^1.5.20",
-    "@types/graceful-fs": "^4.1.5",
-    "@types/mkdirp": "^1.0.2",
-    "@types/semver": "^7.3.9",
-    "ajv": "^8.11.0",
-    "archiver": "^5.3.1",
-    "change-case": "^4.1.2",
     "debug": "^4.3.4",
-    "graceful-fs": "^4.2.10",
+    "globby": "^11",
     "js2xmlparser": "^4.0.2",
-    "jsforce": "beta",
-    "mkdirp": "1.0.4",
-    "ts-retry-promise": "^0.6.1",
+    "jsforce": "2.0.0-beta.14",
+    "jszip": "^3.10.0",
     "xml2js": "^0.4.23",
     "xmldom-sfdx-encoding": "^0.1.30"
   },
@@ -61,11 +54,10 @@
     "@salesforce/dev-scripts": "^2.0.2",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.21",
-    "@types/archiver": "^5.3.1",
     "@types/debug": "4.1.7",
-    "@types/jsen": "0.0.21",
-    "@types/jsonwebtoken": "8.5.8",
-    "@types/shelljs": "0.8.11",
+    "@types/globby": "^9.1.0",
+    "@types/jszip": "^3.4.1",
+    "@types/xml2js": "^0.4.11",
     "@typescript-eslint/eslint-plugin": "^5.27.1",
     "@typescript-eslint/parser": "5.27.1",
     "chai": "^4.3.6",

package/lib/package/packageVersion2GP.d.ts

@@ -1,17 +0,0 @@
-import { AsyncCreatable } from '@salesforce/kit';
-import { IPackageVersion2GP, PackageVersion2Options } from '../interfaces';
-/**
- * Package2Version class - Class to be used with 2nd generation package versions
- */
-export declare class PackageVersion2GP extends AsyncCreatable<PackageVersion2Options> implements IPackageVersion2GP {
-    private options;
-    constructor(options: PackageVersion2Options);
-    convert(): Promise<void>;
-    create(): Promise<void>;
-    delete(): Promise<void>;
-    install(): Promise<void>;
-    list(): Promise<void>;
-    uninstall(): Promise<void>;
-    update(): Promise<void>;
-    protected init(): Promise<void>;
-}

package/lib/package/packageVersion2GP.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PackageVersion2GP = void 0;
-/*
- * 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
- */
-const kit_1 = require("@salesforce/kit");
-/**
- * Package2Version class - Class to be used with 2nd generation package versions
- */
-class PackageVersion2GP extends kit_1.AsyncCreatable {
-    // @ts-ignore
-    constructor(options) {
-        super(options);
-        this.options = options;
-    }
-    convert() {
-        return Promise.resolve(undefined);
-    }
-    create() {
-        return Promise.resolve(undefined);
-    }
-    delete() {
-        return Promise.resolve(undefined);
-    }
-    install() {
-        return Promise.resolve(undefined);
-    }
-    list() {
-        return Promise.resolve(undefined);
-    }
-    uninstall() {
-        return Promise.resolve(undefined);
-    }
-    update() {
-        return Promise.resolve(undefined);
-    }
-    init() {
-        return Promise.resolve(undefined);
-    }
-}
-exports.PackageVersion2GP = PackageVersion2GP;
-//# sourceMappingURL=packageVersion2GP.js.map