@salesforce/packaging 0.0.3 → 0.0.6

package/lib/utils/packageUtils.js

@@ -1,16 +1,17 @@
 "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;
 /*
  * 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.formatDate = exports.getSoqlWhereClauseMaxLength = exports.pollForStatusWithInterval = exports._getPackageVersionCreateRequestApi = 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;
+const os = require("os");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const interfaces_1 = require("../interfaces");
-const packageVersionCreateRequestApi_1 = require("../package/packageVersionCreateRequestApi");
+const pvcr = require("../package/packageVersionCreateRequest");
 const versionNumber_1 = require("./versionNumber");
 var Package2VersionStatus = interfaces_1.PackagingSObjects.Package2VersionStatus;
 core_1.Messages.importMessagesDirectory(__dirname);
@@ -282,7 +283,7 @@ async function getContainerOptions(package2Ids, connection) {
     if (!package2Ids || package2Ids.length === 0) {
         return new Map();
     }
-    const query = 'SELECT Id, ContainerOptions FROM Package2 WHERE Id IN (%IDS%)';
+    const query = "SELECT Id, ContainerOptions FROM Package2 WHERE Id IN ('%IDS%')";
     const records = await queryWithInConditionChunking(query, package2Ids, '%IDS%', connection);
     if (records && records.length > 0) {
         return new Map(records.map((record) => [record.Id, record.ContainerOptions]));
@@ -618,13 +619,14 @@ exports.convertCamelCaseStringToSentence = convertCamelCaseStringToSentence;
  * @returns an array of alias for the given id.
  */
 function getPackageAliasesFromId(packageId, project) {
-    const packageAliases = project.getSfProjectJson().getContents().packageAliases || {};
+    const packageAliases = (project === null || project === void 0 ? void 0 : project.getSfProjectJson().getContents().packageAliases) || {};
     // check for a matching alias
     return Object.entries(packageAliases)
         .filter((alias) => alias[1] === packageId)
         .map((alias) => alias[0]);
 }
 exports.getPackageAliasesFromId = getPackageAliasesFromId;
+// probably used by convert.
 async function findOrCreatePackage2(seedPackage, connection) {
     const query = `SELECT Id FROM Package2 WHERE ConvertedFromPackageId = '${seedPackage}'`;
     const queryResult = await connection.tooling.query(query);
@@ -653,22 +655,17 @@ async function findOrCreatePackage2(seedPackage, connection) {
     };
     const createResult = await connection.tooling.create('Package2', request);
     if (!createResult.success) {
-        throw new Error(createResult.errors.map((e) => e.message).join('\n'));
+        throw combineSaveErrors('Package2', 'create', createResult.errors);
     }
     return createResult.id;
 }
 exports.findOrCreatePackage2 = findOrCreatePackage2;
-function _getPackageVersionCreateRequestApi(connection) {
-    return new packageVersionCreateRequestApi_1.PackageVersionCreateRequestApi({ connection });
-}
-exports._getPackageVersionCreateRequestApi = _getPackageVersionCreateRequestApi;
-async function pollForStatusWithInterval(context, id, retries, packageId, branch, withProject, connection, interval) {
+async function pollForStatusWithInterval(id, retries, packageId, branch, withProject, connection, interval) {
     let remainingRetries = retries;
     const pollingClient = await core_1.PollingClient.create({
         poll: async () => {
             var _a;
-            const pvcrApi = new packageVersionCreateRequestApi_1.PackageVersionCreateRequestApi({ connection });
-            const results = await pvcrApi.byId(id);
+            const results = await pvcr.byId(id, connection);
             if (_isStatusEqualTo(results, [Package2VersionStatus.success, Package2VersionStatus.error])) {
                 // complete
                 if (_isStatusEqualTo(results, [Package2VersionStatus.success])) {
@@ -783,4 +780,45 @@ function formatDate(date) {
     return `${date.getFullYear()}-${pad(date.getMonth() + 1)}-${pad(date.getDate())} ${pad(date.getHours())}:${pad(date.getMinutes())}`;
 }
 exports.formatDate = formatDate;
+function combineSaveErrors(sObject, crudOperation, errors) {
+    const errorMessages = errors.map((error) => {
+        var _a;
+        const fieldsString = ((_a = error.fields) === null || _a === void 0 ? void 0 : _a.length) > 0 ? `Fields: [${error.fields.join(', ')}]` : '';
+        return `Error: ${error.errorCode} Message: ${error.message} ${fieldsString}`;
+    });
+    const sfError = messages.createError('errorDuringSObjectCRUDOperation', [
+        crudOperation,
+        sObject,
+        errorMessages.join(os.EOL),
+    ]);
+    return sfError;
+}
+exports.combineSaveErrors = combineSaveErrors;
+function resolveCanonicalPackageProperty(options) {
+    let canonicalPackageProperty;
+    if (!options.package) {
+        const packageValProp = this.getPackageValuePropertyFromDirectory(options.path, options);
+        options.package = packageValProp.packageValue;
+        canonicalPackageProperty = packageValProp.packageProperty;
+    }
+    else if (!options.path) {
+        canonicalPackageProperty = this.getPackagePropertyFromPackage(this.project.getPackageDirectories(), options);
+        options.path = this.getConfigPackageDirectoriesValue(this.project.getPackageDirectories(), 'path', canonicalPackageProperty, options.package, 'package', options);
+    }
+    else {
+        canonicalPackageProperty = this.getPackagePropertyFromPackage(this.project.getPackageDirectories(), options);
+        this.getConfigPackageDirectoriesValue(this.project.getPackageDirectories(), canonicalPackageProperty, 'path', options.path, 'path', options);
+        const expectedPackageId = this.getConfigPackageDirectoriesValue(this.packageDirs, canonicalPackageProperty, 'path', options.path, 'path', options);
+        // This will throw an error if the package id flag value doesn't match
+        // any of the :id values in the package dirs.
+        this.getConfigPackageDirectoriesValue(this.project.getPackageDirectories(), 'path', canonicalPackageProperty, options.package, 'package', options);
+        // This will throw an error if the package id flag value doesn't match
+        // the correct corresponding directory with that packageId.
+        if (options.package !== expectedPackageId) {
+            throw messages.createError('errorDirectoryIdMismatch', ['--path', options.path, '--package', options.package]);
+        }
+    }
+    return canonicalPackageProperty;
+}
+exports.resolveCanonicalPackageProperty = resolveCanonicalPackageProperty;
 //# sourceMappingURL=packageUtils.js.map

package/lib/utils/srcDevUtils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Zips directory to given zipfile.
+ *
+ * https://github.com/archiverjs/node-archiver
+ *
+ * @param dir to zip
+ * @param zipfile
+ * @param options
+ */
+export declare function zipDir(dir: string, zipfile: string, options?: {}): Promise<void>;
+export declare function getElapsedTime(timer: [number, number]): string;
+export declare function copyDir(src: string, dest: string): void;

package/lib/utils/srcDevUtils.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copyDir = exports.getElapsedTime = exports.zipDir = void 0;
+/*
+ * Copyright (c) 2020, 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 path = require("path");
+const os = require("os");
+const fs = require("fs");
+const path_1 = require("path");
+const archiver = require("archiver");
+const core_1 = require("@salesforce/core");
+/**
+ * Zips directory to given zipfile.
+ *
+ * https://github.com/archiverjs/node-archiver
+ *
+ * @param dir to zip
+ * @param zipfile
+ * @param options
+ */
+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
+    });
+    archive.on('error', (err) => {
+        Promise.reject(err);
+    });
+    output.on('close', () => {
+        Promise.resolve(outFile);
+    });
+    archive.pipe(output);
+    archive.directory(dir, '');
+    return await archive.finalize();
+}
+exports.zipDir = zipDir;
+function getElapsedTime(timer) {
+    const elapsed = process.hrtime(timer);
+    return (elapsed[0] * 1000 + elapsed[1] / 1000000).toFixed(3);
+}
+exports.getElapsedTime = getElapsedTime;
+function copyDir(src, dest) {
+    fs.mkdirSync(dest, { recursive: true });
+    const entries = fs.readdirSync(src, { withFileTypes: true });
+    entries.map((entry) => {
+        const srcPath = (0, path_1.join)(src, entry.name);
+        const destPath = (0, path_1.join)(dest, entry.name);
+        return entry.isDirectory() ? copyDir(srcPath, destPath) : fs.copyFileSync(srcPath, destPath);
+    });
+}
+exports.copyDir = copyDir;
+//# sourceMappingURL=srcDevUtils.js.map

package/lib/utils/versionNumber.d.ts

@@ -13,4 +13,5 @@ export declare class VersionNumber {
     private constructor();
     static from(versionString: string): VersionNumber;
     toString(): string;
+    isbuildKeyword(): boolean;
 }

package/lib/utils/versionNumber.js

@@ -51,6 +51,11 @@ class VersionNumber {
             return `${this.major || '0'}.${this.minor || '0'}.${this.patch || '0'}.${this.build ? `${this.build}` : '0'}`;
         }
     }
+    isbuildKeyword() {
+        return Object.values(BuildNumberToken)
+            .map((v) => v.toString())
+            .includes(this.build.toLowerCase());
+    }
 }
 exports.VersionNumber = VersionNumber;
 //# sourceMappingURL=versionNumber.js.map

package/messages/messages.md

@@ -189,3 +189,20 @@ Can’t create package version. Specifying an ancestor is available only for sec
 
 When calculating the number of items to be included in query "%s", when formatted, was too long.
 The item was (truncated): %s with a length of %s. The maximum length of items, when formatted is %s.
+
+# unableToFindPackageWithId
+
+Unable to find Package with Id: "%s"
+
+# errorDuringSObjectCRUDOperation
+
+An error occurred during CRUD operation %s on entity %s.
+%s
+
+# errorNoMatchingPackageDirectory
+
+The %s value [%s], doesn’t match the %s value in any packageDirectories specified in sfdx-project.json.
+
+# 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.,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -19,7 +19,8 @@
     "prepack": "sf-prepack",
     "prepare": "sf-install",
     "pretest": "sf-compile-test",
-    "test": "sf-test"
+    "test": "sf-test",
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel"
   },
   "keywords": [
     "force",
@@ -34,9 +35,10 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/core": "^3.21.0",
+    "@salesforce/core": "^3.23.4",
     "@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",
@@ -47,11 +49,14 @@
     "debug": "^4.3.4",
     "graceful-fs": "^4.2.10",
     "js2xmlparser": "^4.0.2",
-    "jsforce": "2.0.0-beta.10",
+    "jsforce": "beta",
     "mkdirp": "1.0.4",
-    "ts-retry-promise": "^0.6.1"
+    "ts-retry-promise": "^0.6.1",
+    "xml2js": "^0.4.23",
+    "xmldom-sfdx-encoding": "^0.1.30"
   },
   "devDependencies": {
+    "@salesforce/cli-plugins-testkit": "^2.3.0",
     "@salesforce/dev-config": "^3.0.1",
     "@salesforce/dev-scripts": "^2.0.2",
     "@salesforce/prettier-config": "^0.0.2",

package/lib/package/packageVersionCreateRequestApi.d.ts

@@ -1,17 +0,0 @@
-import { Connection } from '@salesforce/core';
-import { Package2VersionCreateRequestResult } from '../interfaces';
-declare type PackageVersionCreateRequestApiOptions = {
-    createdlastdays?: number;
-    connection?: Connection;
-    status?: string;
-};
-export declare class PackageVersionCreateRequestApi {
-    private options;
-    constructor(options: PackageVersionCreateRequestApiOptions);
-    list(options?: PackageVersionCreateRequestApiOptions): Promise<Package2VersionCreateRequestResult[]>;
-    byId(package2VersionCreateRequestId: any): Promise<Package2VersionCreateRequestResult[]>;
-    private _query;
-    private _queryErrors;
-    private _constructWhere;
-}
-export {};

package/lib/package/packageVersionCreateRequestApi.js

@@ -1,92 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2020, 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.PackageVersionCreateRequestApi = void 0;
-// Node
-const util = require("util");
-// Local
-const core_1 = require("@salesforce/core");
-core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const packageUtils = require('../utils/packageUtils');
-const STATUS_ERROR = 'Error';
-const QUERY = 'SELECT Id, Status, Package2Id, Package2VersionId, Package2Version.SubscriberPackageVersionId, Tag, Branch, ' +
-    'CreatedDate, Package2Version.HasMetadataRemoved, CreatedById ' +
-    'FROM Package2VersionCreateRequest ' +
-    '%s' + // WHERE, if applicable
-    'ORDER BY CreatedDate';
-const ERROR_QUERY = "SELECT Message FROM Package2VersionCreateRequestError WHERE ParentRequest.Id = '%s'";
-const STATUSES = ['Queued', 'InProgress', 'Success', 'Error'];
-class PackageVersionCreateRequestApi {
-    constructor(options) {
-        this.options = options;
-    }
-    list(options = {}) {
-        const whereClause = this._constructWhere();
-        return this._query(util.format(QUERY, whereClause));
-    }
-    async byId(package2VersionCreateRequestId) {
-        const results = await this._query(util.format(QUERY, `WHERE Id = '${package2VersionCreateRequestId}' `));
-        if (results && results.length === 1 && results[0].Status === STATUS_ERROR) {
-            results[0].Error = await this._queryErrors(package2VersionCreateRequestId);
-        }
-        return results;
-    }
-    async _query(query) {
-        const queryResult = await this.options.connection.tooling.query(query);
-        return (queryResult.records ? queryResult.records : []).map((record) => ({
-            Id: record.Id,
-            Status: record.Status,
-            Package2Id: record.Package2Id,
-            Package2VersionId: record.Package2VersionId,
-            SubscriberPackageVersionId: record.Package2Version != null ? record.Package2Version.SubscriberPackageVersionId : null,
-            Tag: record.Tag,
-            Branch: record.Branch,
-            Error: [],
-            CreatedDate: packageUtils.formatDate(new Date(record.CreatedDate)),
-            HasMetadataRemoved: record.Package2Version != null ? record.Package2Version.HasMetadataRemoved : null,
-            CreatedBy: record.CreatedById,
-        }));
-    }
-    async _queryErrors(package2VersionCreateRequestId) {
-        const errorResults = [];
-        const queryResult = await this.options.connection.tooling.query(util.format(ERROR_QUERY, package2VersionCreateRequestId));
-        if (queryResult.records) {
-            queryResult.records.forEach((record) => {
-                errorResults.push(record.Message);
-            });
-        }
-        return errorResults;
-    }
-    _constructWhere() {
-        const where = [];
-        // filter on created date, days ago: 0 for today, etc
-        if (!util.isNullOrUndefined(this.options.createdlastdays)) {
-            if (this.options.createdlastdays < 0) {
-                throw new Error(messages.getMessage('invalidDaysNumber', ['createdlastdays', this.options.createdlastdays]));
-            }
-            where.push(`CreatedDate = LAST_N_DAYS:${this.options.createdlastdays}`);
-        }
-        // filter on errors
-        if (this.options.status) {
-            const foundStatus = STATUSES.find((status) => status.toLowerCase() === this.options.status.toLowerCase());
-            if (!foundStatus) {
-                const args = [this.options.status];
-                STATUSES.forEach((status) => {
-                    args.push(status);
-                });
-                throw new Error(messages.getMessage('invalidStatus', args));
-            }
-            where.push(`Status = '${foundStatus}'`);
-        }
-        return where.length > 0 ? `WHERE ${where.join(' AND ')}` : '';
-    }
-}
-exports.PackageVersionCreateRequestApi = PackageVersionCreateRequestApi;
-//# sourceMappingURL=packageVersionCreateRequestApi.js.map