@salesforce/packaging 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.4](https://github.com/forcedotcom/packaging/compare/v0.0.3...v0.0.4) (2022-06-23)
+
 ### [0.0.3](https://github.com/forcedotcom/packaging/compare/v0.0.2-test-02...v0.0.3) (2022-06-16)
 
 ### Bug Fixes

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -54,3 +54,38 @@ export declare type Package2VersionCreateEventData = {
     message?: string;
     timeRemaining?: Duration;
 };
+export declare type PackageVersionListResult = {
+    Id: string;
+    Package2Id: string;
+    SubscriberPackageVersionId: string;
+    Name: string;
+    Package2: {
+        [key: string]: unknown;
+        Name: string;
+        NamespacePrefix: string;
+        IsOrgDependent?: boolean;
+    };
+    Description: string;
+    Tag: string;
+    Branch: string;
+    MajorVersion: string;
+    MinorVersion: string;
+    PatchVersion: string;
+    BuildNumber: string;
+    IsReleased: boolean;
+    CreatedDate: string;
+    LastModifiedDate: string;
+    IsPasswordProtected: boolean;
+    AncestorId: string;
+    ValidationSkipped: boolean;
+    CreatedById: string;
+    CodeCoverage?: {
+        [key: string]: unknown;
+        ApexCodeCoveragePercentage: number;
+    };
+    HasPassedCodeCoverageCheck?: boolean;
+    ConvertedFromVersionId?: string;
+    ReleaseVersion?: string;
+    BuildDurationInSeconds?: number;
+    HasMetadataRemoved?: boolean;
+};

package/lib/package/index.d.ts

@@ -1,3 +1,4 @@
 export * from './package';
 export * from './packageVersion2GP';
 export * from './packageList';
+export { listPackageVersions } from './packageVersionList';

package/lib/package/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.listPackageVersions = void 0;
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -23,4 +24,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./package"), exports);
 __exportStar(require("./packageVersion2GP"), exports);
 __exportStar(require("./packageList"), exports);
+var packageVersionList_1 = require("./packageVersionList");
+Object.defineProperty(exports, "listPackageVersions", { enumerable: true, get: function () { return packageVersionList_1.listPackageVersions; } });
 //# sourceMappingURL=index.js.map

package/lib/package/packageVersionList.d.ts

@@ -0,0 +1,29 @@
+import { Connection, SfProject } from '@salesforce/core';
+import { QueryResult } from 'jsforce';
+import { PackageVersionListResult } from '../interfaces';
+export declare const DEFAULT_ORDER_BY_FIELDS = "Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber";
+export declare function listPackageVersions(options: {
+    project: SfProject;
+    orderBy: string;
+    modifiedLastDays: number;
+    createdLastDays: number;
+    packages: string[];
+    connection: Connection;
+    verbose: boolean;
+    concise: boolean;
+    isReleased: boolean;
+}): Promise<QueryResult<PackageVersionListResult>>;
+export declare function _constructQuery(options: {
+    project: SfProject;
+    orderBy: string;
+    modifiedLastDays: number;
+    createdLastDays: number;
+    packages: string[];
+    connection: Connection;
+    verbose: boolean;
+    concise: boolean;
+    isReleased: boolean;
+}): string;
+export declare function _assembleQueryParts(select: string, where: string[], orderBy?: string): string;
+export declare function _constructWhere(idsOrAliases: string[], createdLastDays: number, lastModLastDays: number, project: SfProject): string[];
+export declare function _getLastDays(paramName: string, lastDays: number): number;

package/lib/package/packageVersionList.js

@@ -0,0 +1,92 @@
+"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._getLastDays = exports._constructWhere = exports._assembleQueryParts = exports._constructQuery = exports.listPackageVersions = exports.DEFAULT_ORDER_BY_FIELDS = void 0;
+const _ = require("lodash");
+const core_1 = require("@salesforce/core");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
+const ts_types_1 = require("@salesforce/ts-types");
+const utils_1 = require("../utils");
+// Stripping CodeCoverage, HasPassedCodeCoverageCheck as they are causing a perf issue in 47.0+ W-6997762
+const DEFAULT_SELECT = 'SELECT Id, Package2Id, SubscriberPackageVersionId, Name, Package2.Name, Package2.NamespacePrefix, ' +
+    'Description, Tag, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber, IsReleased, ' +
+    'CreatedDate, LastModifiedDate, IsPasswordProtected, AncestorId, ValidationSkipped, CreatedById ' +
+    'FROM Package2Version';
+const VERBOSE_SELECT = 'SELECT Id, Package2Id, SubscriberPackageVersionId, Name, Package2.Name, Package2.NamespacePrefix, ' +
+    'Description, Tag, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber, IsReleased, ' +
+    'CreatedDate, LastModifiedDate, IsPasswordProtected, CodeCoverage, HasPassedCodeCoverageCheck, AncestorId, ValidationSkipped, ' +
+    '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');
+async function listPackageVersions(options) {
+    return options.connection.tooling.query(_constructQuery(options));
+}
+exports.listPackageVersions = listPackageVersions;
+function _constructQuery(options) {
+    // construct custom WHERE clause, if applicable
+    const where = _constructWhere(options.packages, options.createdLastDays, options.modifiedLastDays, options.project);
+    if (options.isReleased) {
+        where.push('IsReleased = true');
+    }
+    return _assembleQueryParts(options.verbose === true ? VERBOSE_SELECT : DEFAULT_SELECT, where, options.orderBy);
+}
+exports._constructQuery = _constructQuery;
+function _assembleQueryParts(select, where, orderBy = exports.DEFAULT_ORDER_BY_FIELDS) {
+    // construct ORDER BY clause
+    // TODO: validate given fields
+    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);
+    return query;
+}
+exports._assembleQueryParts = _assembleQueryParts;
+// construct custom WHERE clause parts
+function _constructWhere(idsOrAliases, createdLastDays, lastModLastDays, project) {
+    const where = [];
+    // filter on given package ids
+    if ((idsOrAliases === null || idsOrAliases === void 0 ? void 0 : idsOrAliases.length) > 0) {
+        // remove dups
+        idsOrAliases = _.uniq(idsOrAliases);
+        // resolve any aliases
+        const packageIds = idsOrAliases.map((idOrAlias) => (0, utils_1.getPackageIdFromAlias)(idOrAlias, project));
+        // validate ids
+        packageIds.forEach((packageId) => {
+            (0, utils_1.validateId)(utils_1.BY_LABEL.PACKAGE_ID, packageId);
+        });
+        // stash where part
+        where.push(`Package2Id IN ('${packageIds.join("','")}')`);
+    }
+    // filter on created date, days ago: 0 for today, etc
+    if ((0, ts_types_1.isNumber)(createdLastDays)) {
+        createdLastDays = _getLastDays('createdlastdays', createdLastDays);
+        where.push(`CreatedDate = LAST_N_DAYS:${createdLastDays}`);
+    }
+    // filter on last mod date, days ago: 0 for today, etc
+    if ((0, ts_types_1.isNumber)(lastModLastDays)) {
+        lastModLastDays = _getLastDays('modifiedlastdays', lastModLastDays);
+        where.push(`LastModifiedDate = LAST_N_DAYS:${lastModLastDays}`);
+    }
+    // exclude deleted
+    where.push('IsDeprecated = false');
+    return where;
+}
+exports._constructWhere = _constructWhere;
+function _getLastDays(paramName, lastDays) {
+    if (isNaN(lastDays)) {
+        return 0;
+    }
+    if (lastDays < 0) {
+        throw messages.createError('invalidDaysNumber', [paramName, `${lastDays}`]);
+    }
+    return lastDays;
+}
+exports._getLastDays = _getLastDays;
+//# sourceMappingURL=packageVersionList.js.map

package/lib/utils/packageUtils.js

@@ -282,7 +282,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,7 +618,7 @@ 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)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "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",
@@ -52,6 +53,7 @@
     "ts-retry-promise": "^0.6.1"
   },
   "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",