@salesforce/packaging 0.0.2 → 0.0.5

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/package1/index.d.ts

@@ -1 +1 @@
-export * from './package1Version';
+export * from './packageVersion1GP';

package/lib/package1/index.js

@@ -20,5 +20,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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
  */
-__exportStar(require("./package1Version"), exports);
+__exportStar(require("./packageVersion1GP"), exports);
 //# sourceMappingURL=index.js.map

package/lib/package1/{package1Version.d.ts → packageVersion1GP.d.ts}

@@ -1,11 +1,11 @@
 import { AsyncCreatable } from '@salesforce/kit';
-import { IPackage1Version, PackageVersion1Options } from '../interfaces';
+import { IPackageVersion1GP, PackageVersionOptions1GP } from '../interfaces';
 /**
  * Package1Version class - Class to be used with 1st generation package versions
  */
-export declare class Package1Version extends AsyncCreatable<PackageVersion1Options> implements IPackage1Version {
+export declare class PackageVersion1GP extends AsyncCreatable<PackageVersionOptions1GP> implements IPackageVersion1GP {
     private options;
-    constructor(options: PackageVersion1Options);
+    constructor(options: PackageVersionOptions1GP);
     convert(): Promise<void>;
     create(): Promise<void>;
     delete(): Promise<void>;

package/lib/package1/{package1Version.js → packageVersion1GP.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Package1Version = void 0;
+exports.PackageVersion1GP = void 0;
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -11,7 +11,7 @@ const kit_1 = require("@salesforce/kit");
 /**
  * Package1Version class - Class to be used with 1st generation package versions
  */
-class Package1Version extends kit_1.AsyncCreatable {
+class PackageVersion1GP extends kit_1.AsyncCreatable {
     // @ts-ignore
     constructor(options) {
         super(options);
@@ -42,5 +42,5 @@ class Package1Version extends kit_1.AsyncCreatable {
         return Promise.resolve(undefined);
     }
 }
-exports.Package1Version = Package1Version;
-//# sourceMappingURL=package1Version.js.map
+exports.PackageVersion1GP = PackageVersion1GP;
+//# sourceMappingURL=packageVersion1GP.js.map

package/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './packageUtils';

package/lib/utils/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+/*
+ * 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
+ */
+__exportStar(require("./packageUtils"), exports);
+//# sourceMappingURL=index.js.map

package/lib/utils/packageUtils.d.ts

@@ -0,0 +1,152 @@
+import { Connection, NamedPackageDir, PackageDir, SfProject } from '@salesforce/core';
+import { Duration } from '@salesforce/kit';
+import { Many } from '@salesforce/ts-types';
+import { PackagingSObjects, Package2VersionCreateRequestResult } from '../interfaces';
+import { PackageVersionCreateRequestApi } from '../package/packageVersionCreateRequestApi';
+export declare const VERSION_NUMBER_SEP = ".";
+export declare type IdRegistryValue = {
+    prefix: string;
+    label: string;
+};
+export declare type IdRegistry = {
+    [key: string]: IdRegistryValue;
+};
+export declare const INSTALL_URL_BASE = "https://login.salesforce.com/packaging/installPackage.apexp?p0=";
+export declare const SOQL_WHERE_CLAUSE_MAX_LENGTH = 4000;
+export declare const POLL_INTERVAL_SECONDS = 30;
+export declare const DEFAULT_PACKAGE_DIR: {
+    path: string;
+    package: string;
+    versionName: string;
+    versionNumber: string;
+    default: boolean;
+};
+export declare const BY_PREFIX: IdRegistry;
+export declare const BY_LABEL: IdRegistry;
+export declare function validateId(idObj: Many<IdRegistryValue>, value: string): void;
+export declare function validateIdNoThrow(idObj: Many<IdRegistryValue>, value: any): any;
+export declare function validateVersionNumber(versionNumberString: string, supportedBuildNumberToken: string, supportedBuildNumberToken2: string): string;
+export declare function validatePatchVersion(connection: Connection, versionNumberString: string, packageId: string): Promise<void>;
+export declare function validUrl(url: string): boolean;
+export declare function isErrorFromSPVQueryRestriction(err: Error): boolean;
+export declare function isErrorPackageNotAvailable(err: Error): boolean;
+export declare function massageErrorMessage(err: Error): Error;
+export declare function applyErrorAction(err: Error): Error;
+/**
+ * Given a subscriber package version ID (04t) or package version ID (05i), return the package version ID (05i)
+ *
+ * @param versionId The subscriber package version ID
+ * @param connection For tooling query
+ */
+export declare function getPackageVersionId(versionId: string, connection: Connection): Promise<string>;
+/**
+ * Given 0Ho the package type type (Managed, Unlocked, Locked(deprecated?))
+ *
+ * @param package2Id the 0Ho
+ * @param connection For tooling query
+ * @throws Error with message when package2 cannot be found
+ */
+export declare function getPackage2Type(package2Id: string, connection: Connection): Promise<string>;
+/**
+ * Given 04t the package type type (Managed, Unlocked, Locked(deprecated?))
+ *
+ * @param package2VersionId 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
+ */
+export declare function getPackage2TypeBy04t(package2VersionId: string, connection: Connection, installKey: string): Promise<string>;
+/**
+ * Given a package version ID (05i) or subscriber package version ID (04t), return the subscriber package version ID (04t)
+ *
+ * @param versionId The suscriber package version ID
+ * @param connection For tooling query
+ */
+export declare function getSubscriberPackageVersionId(versionId: string, connection: Connection): Promise<string>;
+/**
+ * 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 connection For tooling query
+ */
+export declare function getContainerOptions(package2Ids: string[], connection: Connection): Promise<Map<string, string>>;
+/**
+ * Return the Package2Version.HasMetadataRemoved field value for the given Id (05i)
+ *
+ * @param packageVersionId package version ID (05i)
+ * @param connection For tooling query
+ */
+export declare function getHasMetadataRemoved(packageVersionId: string, connection: Connection): Promise<boolean>;
+/**
+ * Given a list of subscriber package version IDs (04t), return the associated version strings (e.g., Major.Minor.Patch.Build)
+ *
+ * @return Map of subscriberPackageVersionId to versionString
+ * @param subscriberPackageVersionIds
+ * @param connection For tooling query
+ */
+export declare function getPackageVersionStrings(subscriberPackageVersionIds: string[], connection: Connection): Promise<Map<string, string>>;
+/**
+ * For queries with an IN condition, determine if the WHERE clause will exceed
+ * SOQL's 4000 character limit.  Perform multiple queries as needed to stay below the limit.
+ *
+ * @return concatenated array of records returned from the resulting query(ies)
+ * @param query The full query to execute containing the replaceToken param in its IN clause
+ * @param items The IN clause items.  A length-appropriate single-quoted comma-separated string chunk will be made from the items.
+ * @param replaceToken A placeholder in the query's IN condition that will be replaced with the chunked items
+ * @param connection For tooling query
+ */
+export declare function queryWithInConditionChunking<T = Record<string, unknown>>(query: string, items: string[], replaceToken: string, connection: Connection): Promise<T[]>;
+/**
+ *   Returns the number of items that can be included in a quoted comma-separated string (e.g., "'item1','item2'") not exceeding maxLength
+ */
+export declare function getInClauseItemsCount(items: string[], startIndex: number, maxLength: number): number;
+/**
+ * Given a package descriptor, return the ancestor ID. This code was duplicated to scratchOrgInfoGenerator.getAncestorIds,
+ * changes here may need to be duplicated there until that code, and/or this code is moved to a separate plugin.
+ *
+ * @param packageDescriptorJson JSON for packageDirectories element in sfdx-project.json
+ * @param connection For tooling query
+ * @param project The project to use for looking up the ancestor ID
+ * @param versionNumberString The version number string to use for looking up the ancestor ID
+ * @param skipAncestorCheck If true, skip the check for the ancestor ID
+ */
+export declare function getAncestorId(packageDescriptorJson: PackageDir, connection: Connection, project: SfProject, versionNumberString: string, skipAncestorCheck: boolean): Promise<string>;
+export declare function validateAncestorId(ancestorId: string, highestReleasedVersion: PackagingSObjects.Package2Version, explicitUseNoAncestor: boolean, isPatch: boolean, skipAncestorCheck: boolean, origSpecifiedAncestor: string): string;
+export declare function getAncestorIdHighestRelease(connection: Connection, packageId: string, versionNumberString: string, explicitUseHighestRelease: boolean, skipAncestorCheck: boolean): Promise<{
+    finalAncestorId: string;
+    highestReleasedVersion: PackagingSObjects.Package2Version;
+}>;
+/**
+ * Return a version string in Major.Minor.Patch.Build format, using 0 for any empty part
+ */
+export declare function concatVersion(major: string | number, minor: string | number, patch: string | number, build: string | number): string;
+export declare function getPackage2VersionNumber(package2VersionObj: PackagingSObjects.Package2Version): string;
+export declare function getConfigPackageDirectories(project: SfProject): PackageDir[];
+export declare function getConfigPackageDirectory(packageDirs: NamedPackageDir[], lookupProperty: string, lookupValue: unknown): NamedPackageDir | undefined;
+/**
+ * Given a packageAlias, attempt to return the associated id from the config
+ *
+ * @param packageAlias string representing a package alias
+ * @param project for obtaining the project config
+ * @returns the associated id or the arg given.
+ */
+export declare function getPackageIdFromAlias(packageAlias: string, project: SfProject): string;
+/**
+ * @param stringIn pascal or camel case string
+ * @returns space delimited and lower-cased (except for 1st char) string (e.g. in "AbcdEfghIj" => "Abcd efgh ij")
+ */
+export declare function convertCamelCaseStringToSentence(stringIn: string): string;
+/**
+ * Given a package id, attempt to return the associated aliases from the config
+ *
+ * @param packageId string representing a package id
+ * @param project for obtaining the project config
+ * @returns an array of alias for the given id.
+ */
+export declare function getPackageAliasesFromId(packageId: string, project: SfProject): string[];
+export declare function findOrCreatePackage2(seedPackage: string, connection: Connection): Promise<string>;
+export declare function _getPackageVersionCreateRequestApi(connection: Connection): PackageVersionCreateRequestApi;
+export declare function pollForStatusWithInterval(context: any, id: string, retries: number, packageId: string, branch: string, withProject: SfProject, connection: Connection, interval: Duration): Promise<Package2VersionCreateRequestResult>;
+export declare function getSoqlWhereClauseMaxLength(): number;
+export declare function formatDate(date: Date): string;