@salesforce/packaging 0.0.6 → 0.0.9

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.9](https://github.com/forcedotcom/packaging/compare/v0.0.8...v0.0.9) (2022-07-19)
+
+### Features
+
+- add package1Display method for use with package1:version:display command ([ef3df30](https://github.com/forcedotcom/packaging/commit/ef3df309147bafb16367c957981a04470c6ad7df))
+
+### [0.0.8](https://github.com/forcedotcom/packaging/compare/v0.0.7...v0.0.8) (2022-07-18)
+
+### Features
+
+- add package1VersionDisplayGet method ([0de1b9e](https://github.com/forcedotcom/packaging/commit/0de1b9e730dc1dc18c68f4efa7bbc2e2b0b43807))
+
+### [0.0.7](https://github.com/forcedotcom/packaging/compare/v0.0.6...v0.0.7) (2022-07-14)
+
+### Bug Fixes
+
+- add package version create/delete to library ([7713d4d](https://github.com/forcedotcom/packaging/commit/7713d4dc7d25f2a381a6972e57f24c9fbdcbae05))
+
 ### [0.0.6](https://github.com/forcedotcom/packaging/compare/v0.0.5...v0.0.6) (2022-07-08)
 
 ### Bug Fixes

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -1,7 +1,7 @@
 import { Duration } from '@salesforce/kit';
 import { Connection, SfProject } from '@salesforce/core';
 import { SaveResult } from 'jsforce';
-import { ProfileApi } from '../package/profileApi';
+import { PackageProfileApi } from '../package/packageProfileApi';
 import { PackagingSObjects } from './packagingSObjects';
 import Package2VersionStatus = PackagingSObjects.Package2VersionStatus;
 export interface IPackage {
@@ -34,7 +34,7 @@ export interface IPackageVersion2GP {
 export declare type PackageOptions = Record<string, unknown>;
 export declare type PackageVersion2Options = Record<string, unknown>;
 export declare type PackageVersionOptions1GP = Record<string, unknown>;
-export declare type Package2VersionCreateRequestResult = {
+export declare type PackageVersionCreateRequestResult = {
     Id: string;
     Status: Package2VersionStatus;
     Package2Id: string;
@@ -47,13 +47,13 @@ export declare type Package2VersionCreateRequestResult = {
     HasMetadataRemoved: boolean | null;
     CreatedBy: string;
 };
-export declare type Package2VersionCreateRequestError = {
+export declare type PackageVersionCreateRequestError = {
     Message: string;
 };
-export declare type Package2VersionCreateEventData = {
+export declare type PackageVersionCreateEventData = {
     id: string;
     packageUpdated?: boolean;
-    package2VersionCreateRequestResult: Package2VersionCreateRequestResult;
+    packageVersionCreateRequestResult: PackageVersionCreateRequestResult;
     message?: string;
     timeRemaining?: Duration;
 };
@@ -92,6 +92,14 @@ export declare type PackageVersionListResult = {
     BuildDurationInSeconds?: number;
     HasMetadataRemoved?: boolean;
 };
+export declare type Package1Display = {
+    MetadataPackageVersionId: string;
+    MetadataPackageId: string;
+    Name: string;
+    Version: string;
+    ReleaseState: string;
+    BuildNumber: number;
+};
 export declare type PackageType = 'Managed' | 'Unlocked';
 export declare type PackageCreateOptions = {
     name: string;
@@ -135,7 +143,7 @@ export declare type PackageVersionOptions = {
     connection: Connection;
     project: SfProject;
 };
-export declare type PackageVersionCreateOptions = PackageVersionOptions & {
+export declare type PackageVersionCreateOptions = Partial<PackageVersionOptions & {
     branch: string;
     buildinstance: string;
     codecoverage: boolean;
@@ -158,10 +166,15 @@ export declare type PackageVersionCreateOptions = PackageVersionOptions & {
     versionname: string;
     versionnumber: string;
     wait: Duration;
-    profileApi?: ProfileApi;
-};
+    profileApi: PackageProfileApi;
+}>;
 export declare type PackageVersionCreateRequestQueryOptions = {
     createdlastdays?: number;
     connection?: Connection;
     status?: string;
 };
+export declare type ProfileApiOptions = {
+    project: SfProject;
+    includeUserLicenses: boolean;
+    generateProfileInformation: boolean;
+};

package/lib/interfaces/packagingSObjects.d.ts

@@ -223,4 +223,15 @@ export declare namespace PackagingSObjects {
         SubscriberPackageVersionId: string;
         MinPackageVersionId: string;
     };
+    type MetadataPackageVersion = {
+        Id: string;
+        MetadataPackageId: string;
+        Name: string;
+        ReleaseState: 'Beta' | 'Released';
+        MajorVersion: number;
+        MinorVersion: number;
+        PatchVersion: number;
+        BuildNumber: number;
+        IsDeprecated: boolean;
+    };
 }

package/lib/package/index.d.ts

@@ -1,5 +1,5 @@
 export * from './package';
-export * from './packageVersion2GP';
+export * from './packageVersion';
 export * from './packageList';
 export * from './packageVersionCreateRequest';
 export { listPackageVersions } from './packageVersionList';

package/lib/package/index.js

@@ -22,7 +22,7 @@ exports.deletePackage = exports.createPackage = exports.listPackageVersions = vo
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 __exportStar(require("./package"), exports);
-__exportStar(require("./packageVersion2GP"), exports);
+__exportStar(require("./packageVersion"), exports);
 __exportStar(require("./packageList"), exports);
 __exportStar(require("./packageVersionCreateRequest"), exports);
 var packageVersionList_1 = require("./packageVersionList");

package/lib/package/packageConvert.d.ts

@@ -1,11 +1,11 @@
 import { Connection, Org, SfProject } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
-import { Package2VersionCreateRequestResult } from '../interfaces';
+import { PackageVersionCreateRequestResult } from '../interfaces';
 declare type ConvertPackageOptions = {
     installationKey: string;
     installationKeyBypass: boolean;
     wait: Duration;
     buildInstance: string;
 };
-export declare function convertPackage(pkg: string, org: Org, connection: Connection, project: SfProject, options: ConvertPackageOptions): Promise<Package2VersionCreateRequestResult>;
+export declare function convertPackage(pkg: string, org: Org, connection: Connection, project: SfProject, options: ConvertPackageOptions): Promise<PackageVersionCreateRequestResult>;
 export {};

package/lib/package/packageConvert.js

@@ -11,24 +11,30 @@ const path = require("path");
 const util = require("util");
 const os = require("os");
 const fs = require("fs");
+const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const testSetup_1 = require("@salesforce/core/lib/testSetup");
 const pkgUtils = require("../utils/packageUtils");
 const constants_1 = require("../constants");
 const srcDevUtil = require("../utils/srcDevUtils");
 const packageVersionCreateRequest_1 = require("./packageVersionCreateRequest");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
 async function convertPackage(pkg, org, connection, project, options) {
     let maxRetries = 0;
     const branch = 'main';
     if (options.wait) {
         maxRetries = (60 / pkgUtils.POLL_INTERVAL_SECONDS) * options.wait.seconds;
     }
-    const packageId = await pkgUtils.findOrCreatePackage2(pkg, connection);
+    const packageId = await pkgUtils.findOrCreatePackage(pkg, connection);
     const request = await createPackageVersionCreateRequest(context, packageId);
     const createResult = await connection.tooling.create('Package2VersionCreateRequest', request);
     if (!createResult.success) {
         const errStr = createResult.errors && createResult.errors.length ? createResult.errors.join(', ') : createResult.errors;
-        throw new Error(`Failed to create request${createResult.id ? ` [${createResult.id}]` : ''}: ${errStr}`);
+        throw messages.createError('failedToCreatePVCRequest', [
+            createResult.id ? ` [${createResult.id}]` : '',
+            errStr.toString(),
+        ]);
     }
     let results;
     if (options.wait) {

package/lib/package/packageCreate.d.ts

@@ -1,7 +1,7 @@
 import { Connection, NamedPackageDir, PackageDir, SfProject } from '@salesforce/core';
 import { PackageCreateOptions, PackagingSObjects } from '../interfaces';
 declare type Package2Request = Pick<PackagingSObjects.Package2, 'Name' | 'Description' | 'NamespacePrefix' | 'ContainerOptions' | 'IsOrgDependent' | 'PackageErrorUsername'>;
-export declare function _createPackage2RequestFromContext(project: SfProject, options: PackageCreateOptions): Package2Request;
+export declare function _createPackageRequestFromContext(project: SfProject, options: PackageCreateOptions): Package2Request;
 /**
  * Generate packageDirectory json entry for this package that can be written to sfdx-project.json
  *

package/lib/package/packageCreate.js

@@ -6,13 +6,13 @@
  * 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.createPackage = exports._generatePackageAliasEntry = exports._generatePackageDirEntry = exports._createPackage2RequestFromContext = void 0;
+exports.createPackage = exports._generatePackageAliasEntry = exports._generatePackageDirEntry = exports._createPackageRequestFromContext = void 0;
 const core_1 = require("@salesforce/core");
 const ts_types_1 = require("@salesforce/ts-types");
 const pkgUtils = require("../utils/packageUtils");
 core_1.Messages.importMessagesDirectory(__dirname);
 const messages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
-function _createPackage2RequestFromContext(project, options) {
+function _createPackageRequestFromContext(project, options) {
     const namespace = options.noNamespace ? '' : project.getSfProjectJson().getContents().namespace || '';
     return {
         Name: options.name,
@@ -23,7 +23,7 @@ function _createPackage2RequestFromContext(project, options) {
         PackageErrorUsername: options.errorNotificationUsername,
     };
 }
-exports._createPackage2RequestFromContext = _createPackage2RequestFromContext;
+exports._createPackageRequestFromContext = _createPackageRequestFromContext;
 /**
  * Generate packageDirectory json entry for this package that can be written to sfdx-project.json
  *
@@ -32,7 +32,6 @@ exports._createPackage2RequestFromContext = _createPackage2RequestFromContext;
  * @private
  */
 function _generatePackageDirEntry(project, options) {
-    var _a, _b;
     let packageDirs = project.getPackageDirectories();
     if (!packageDirs) {
         packageDirs = [];
@@ -47,8 +46,8 @@ function _generatePackageDirEntry(project, options) {
     if (packageDir) {
         // update existing entry
         packageDir.package = options.name;
-        (_a = packageDir.versionName) !== null && _a !== void 0 ? _a : (packageDir.versionName = pkgUtils.DEFAULT_PACKAGE_DIR.versionName);
-        (_b = packageDir.versionNumber) !== null && _b !== void 0 ? _b : (packageDir.versionNumber = pkgUtils.DEFAULT_PACKAGE_DIR.versionNumber);
+        packageDir.versionName ?? (packageDir.versionName = pkgUtils.DEFAULT_PACKAGE_DIR.versionName);
+        packageDir.versionNumber ?? (packageDir.versionNumber = pkgUtils.DEFAULT_PACKAGE_DIR.versionNumber);
         // set as default if this is the only entry or no other entry is the default
         if (!Reflect.getOwnPropertyDescriptor(packageDir, 'default')) {
             packageDir.default = !pkgUtils.getConfigPackageDirectory(packageDirs, 'default', true);
@@ -83,7 +82,7 @@ exports._generatePackageAliasEntry = _generatePackageAliasEntry;
 async function createPackage(connection, project, options) {
     // strip trailing slash from path param
     options.path = options.path.replace(/\/$/, '');
-    const request = _createPackage2RequestFromContext(project, options);
+    const request = _createPackageRequestFromContext(project, options);
     let packageId = null;
     const createResult = await connection.tooling
         .sobject('Package2')
@@ -97,7 +96,7 @@ async function createPackage(connection, project, options) {
     }
     packageId = createResult.id;
     const queryResult = await connection.tooling.query(`SELECT Id FROM Package2 WHERE Id='${packageId}'`);
-    if (!(queryResult === null || queryResult === void 0 ? void 0 : queryResult.records[0])) {
+    if (!queryResult?.records[0]) {
         throw messages.createError('unableToFindPackageWithId', [packageId]);
     }
     const record = queryResult.records[0];

package/lib/package/{profileApi.d.ts → packageProfileApi.d.ts}

@@ -1,8 +1,8 @@
 import { ConfigAggregator, SfProject } from '@salesforce/core';
-export declare class ProfileApi {
-    project: SfProject;
-    includeUserLicenses: boolean;
-    generateProfileInformation: boolean;
+import { AsyncCreatable } from '@salesforce/kit';
+import { ProfileApiOptions } from '../interfaces';
+export declare class PackageProfileApi extends AsyncCreatable<ProfileApiOptions> {
+    private options;
     readonly profiles: ProfileInformation[];
     apiVersion: string;
     nodeEntities: {
@@ -16,7 +16,11 @@ export declare class ProfileApi {
         parentElement: string[];
     };
     config: ConfigAggregator;
-    constructor(project: SfProject, includeUserLicenses: boolean, generateProfileInformation?: boolean);
+    project: SfProject;
+    includeUserLicenses: boolean;
+    generateProfileInformation: boolean;
+    constructor(options: ProfileApiOptions);
+    init(): Promise<void>;
     /**
      * For any profile present in the workspace, this function generates a subset of data that only contains references
      * to items in the manifest.

package/lib/package/{profileApi.js → packageProfileApi.js}

@@ -6,13 +6,13 @@
  * 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.ProfileApi = void 0;
+exports.PackageProfileApi = void 0;
 const path = require("path");
 const fs = require("fs");
 const glob = require("glob");
 const xmldom_sfdx_encoding_1 = require("xmldom-sfdx-encoding");
 const core_1 = require("@salesforce/core");
-// Local
+const kit_1 = require("@salesforce/kit");
 core_1.Messages.importMessagesDirectory(__dirname);
 // TODO: need to transfer these messages
 const profileApiMessages = core_1.Messages.loadMessages('@salesforce/packaging', 'messages');
@@ -21,15 +21,18 @@ const profileApiMessages = core_1.Messages.loadMessages('@salesforce/packaging',
  * All profiles found in the workspaces are extracted out and then re-written to only include metadata in the profile
  * that is relevant to the source in the package directory being packaged.
  */
-class ProfileApi {
-    constructor(project, includeUserLicenses, generateProfileInformation = false) {
-        this.project = project;
-        this.includeUserLicenses = includeUserLicenses;
-        this.generateProfileInformation = generateProfileInformation;
+class PackageProfileApi extends kit_1.AsyncCreatable {
+    constructor(options) {
+        super(options);
+        this.options = options;
         this.profiles = [];
-        (async () => {
-            this.config = await core_1.ConfigAggregator.create();
-        })();
+        this.generateProfileInformation = false;
+    }
+    async init() {
+        this.project = this.options.project;
+        this.includeUserLicenses = this.options.includeUserLicenses;
+        this.generateProfileInformation = this.options.generateProfileInformation;
+        this.config = await core_1.ConfigAggregator.create();
         this.apiVersion = this.config.getPropertyValue('apiVersion');
         // nodeEntities is used to determine which elements in the profile are relevant to the source being packaged.
         // name refers to the entity type name in source that the element pertains to.  As an example, a profile may
@@ -238,7 +241,7 @@ class ProfileApi {
         });
     }
 }
-exports.ProfileApi = ProfileApi;
+exports.PackageProfileApi = PackageProfileApi;
 class ProfileInformation {
     constructor(ProfileName, ProfilePath, IsPackaged, settingsRemoved) {
         this.ProfileName = ProfileName;
@@ -272,4 +275,4 @@ class ProfileInformation {
         }
     }
 }
-//# sourceMappingURL=profileApi.js.map
+//# sourceMappingURL=packageProfileApi.js.map

package/lib/package/packageVersion.d.ts

@@ -1,8 +1,25 @@
-import { Package2VersionCreateRequestResult, PackageVersionCreateOptions, PackageVersionOptions } from '../interfaces';
+import { PackageVersionCreateRequestResult, PackageSaveResult, PackageVersionCreateOptions, PackageVersionOptions } from '../interfaces';
 export declare class PackageVersion {
     private options;
     private readonly project;
     private readonly connection;
-    protected constructor(options: PackageVersionOptions);
-    createPackageVersion(options: PackageVersionCreateOptions): Promise<Partial<Package2VersionCreateRequestResult>>;
+    constructor(options: PackageVersionOptions);
+    /**
+     * Creates a new package version.
+     *
+     * @param options
+     */
+    create(options: PackageVersionCreateOptions): Promise<Partial<PackageVersionCreateRequestResult>>;
+    /**
+     * Deletes a package version.
+     *
+     * @param idOrAlias
+     * @param undelete
+     */
+    delete(idOrAlias: string, undelete?: boolean): Promise<PackageSaveResult>;
+    convert(): Promise<void>;
+    install(): Promise<void>;
+    list(): Promise<void>;
+    uninstall(): Promise<void>;
+    update(): Promise<void>;
 }

package/lib/package/packageVersion.js

@@ -8,6 +8,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PackageVersion = void 0;
 const core_1 = require("@salesforce/core");
+const pkgUtils = require("../utils/packageUtils");
+const utils_1 = require("../utils");
 const packageVersionCreate_1 = require("./packageVersionCreate");
 core_1.Messages.importMessagesDirectory(__dirname);
 // const messages = Messages.loadMessages('@salesforce/packaging', 'messages');
@@ -18,9 +20,53 @@ class PackageVersion {
         this.connection = this.options.connection;
         this.project = this.options.project;
     }
-    async createPackageVersion(options) {
-        const pvc = new packageVersionCreate_1.PackageVersionCreate(options);
-        return pvc.createPackageVersion(options);
+    /**
+     * Creates a new package version.
+     *
+     * @param options
+     */
+    async create(options) {
+        const pvc = new packageVersionCreate_1.PackageVersionCreate({ ...options, ...this.options });
+        return pvc.createPackageVersion();
+    }
+    /**
+     * Deletes a package version.
+     *
+     * @param idOrAlias
+     * @param undelete
+     */
+    async delete(idOrAlias, undelete = false) {
+        const packageVersionId = pkgUtils.getPackageIdFromAlias(idOrAlias, this.project);
+        // ID can be an 04t or 05i
+        pkgUtils.validateId([pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, pkgUtils.BY_LABEL.PACKAGE_VERSION_ID], packageVersionId);
+        // lookup the 05i ID, if needed
+        const packageId = await pkgUtils.getPackageVersionId(packageVersionId, this.connection);
+        // setup the request
+        const request = {
+            Id: packageId,
+            IsDeprecated: !undelete,
+        };
+        const updateResult = await this.connection.tooling.update('Package2Version', request);
+        if (!updateResult.success) {
+            throw (0, utils_1.combineSaveErrors)('Package2', 'update', updateResult.errors);
+        }
+        updateResult.id = await pkgUtils.getSubscriberPackageVersionId(packageVersionId, this.connection);
+        return updateResult;
+    }
+    convert() {
+        return Promise.resolve(undefined);
+    }
+    install() {
+        return Promise.resolve(undefined);
+    }
+    list() {
+        return Promise.resolve(undefined);
+    }
+    uninstall() {
+        return Promise.resolve(undefined);
+    }
+    update() {
+        return Promise.resolve(undefined);
     }
 }
 exports.PackageVersion = PackageVersion;

package/lib/package/packageVersionCreate.d.ts

@@ -1,16 +1,14 @@
 import { Connection } from '@salesforce/core';
-import { Package2VersionCreateRequestResult, PackageVersionCreateOptions } from '../interfaces';
+import { PackageVersionCreateRequestResult, PackageVersionCreateOptions } from '../interfaces';
 export declare class PackageVersionCreate {
     private options;
     private apiVersionFromPackageXml;
-    private packageDirs;
     private readonly project;
     private readonly connection;
     constructor(options: PackageVersionCreateOptions);
-    createPackageVersion(options: PackageVersionCreateOptions): Promise<Partial<Package2VersionCreateRequestResult>>;
-    listRequest(createdlastdays?: number, status?: string): Promise<Package2VersionCreateRequestResult[]>;
-    listRequestById(id: string, connection: Connection): Promise<Package2VersionCreateRequestResult[]>;
-    rejectWithInstallKeyError(): Promise<never>;
+    createPackageVersion(): Promise<Partial<PackageVersionCreateRequestResult>>;
+    listRequest(createdlastdays?: number, status?: string): Promise<PackageVersionCreateRequestResult[]>;
+    listRequestById(id: string, connection: Connection): Promise<PackageVersionCreateRequestResult[]>;
     private generateMDFolderForArtifact;
     private validateDependencyValues;
     /**