@salesforce/packaging 1.0.4 → 1.0.5

package/README.md

@@ -1,5 +1,24 @@
-# Packaging Library for use with Salesforce Packaging Platform
+# Salesforce Packaging
 
 > :warning: **This module is under heavy development, please do not use in production.**
 
-[![NPM](https://img.shields.io/npm/v/@salesforce/packaging.svg?label=@salesforce/packaging)](https://www.npmjs.com/package/@salesforce/packaging) [![CircleCI](https://circleci.com/gh/forcedotcom/packaging/tree/main.svg?style=shield)](https://circleci.com/gh/forcedotcom/packaging/tree/main) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/packaging.svg)](https://npmjs.org/package/@salesforce/packaging) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/forcedotcom/packaging/main/LICENSE.txt)
+[![NPM](https://img.shields.io/npm/v/@salesforce/packaging.svg?label=@salesforce/packaging)](https://www.npmjs.com/package/@salesforce/packaging) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/packaging.svg)](https://npmjs.org/package/@salesforce/packaging) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/forcedotcom/packaging/main/LICENSE.txt)
+
+## Description
+
+A TypeScript library for packaging metadata in your Salesforce project. This library supports both First-Generation packaging (1GP) and Second-Generation packaging (2GP).
+
+## Usage
+
+There are 4 main classes to use from this library:
+
+1. `Package1Version` - Work with 1st generation package versions.
+1. `Package` - Work with 2nd generation packages.
+1. `PackageVersion` - Work with 2nd generation package versions.
+1. `SubscriberPackageVersion` - Work with 2nd generation subscriber package versions.
+
+Please see the [API Documentation](https://forcedotcom.github.io/packaging/) for details.
+
+## Contributing
+
+If you are interested in contributing, please take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -221,6 +221,7 @@ export declare type ConvertPackageOptions = {
     installationKeyBypass: boolean;
     wait: Duration;
     buildInstance: string;
+    frequency?: Duration;
 };
 export declare type PackageVersionCreateOptions = {
     connection: Connection;

package/lib/package/packageConvert.js

@@ -81,7 +81,7 @@ async function convertPackage(pkg, connection, options, project) {
     }
     let results;
     if (options.wait) {
-        results = await pollForStatusWithInterval(createResult.id, maxRetries, packageId, branch, project, connection, new kit_1.Duration(pkgUtils.POLL_INTERVAL_SECONDS, kit_1.Duration.Unit.SECONDS));
+        results = await pollForStatusWithInterval(createResult.id, maxRetries, packageId, branch, project, connection, options.frequency ?? kit_1.Duration.seconds(pkgUtils.POLL_INTERVAL_SECONDS));
     }
     else {
         results = await (0, packageVersionCreateRequest_1.byId)(packageId, connection);

package/lib/package/packageVersionCreate.d.ts

@@ -10,6 +10,15 @@ export declare class PackageVersionCreate {
     private readonly logger;
     constructor(options: PackageVersionCreateOptions);
     createPackageVersion(): Promise<Partial<PackageVersionCreateRequestResult>>;
+    /**
+     * Extracted into a method for UT purposes
+     *
+     * @param componentSet CS to convert
+     * @param outputDirectory where to place the converted MD
+     * @param packageName the packagename related to the CS
+     * @private
+     */
+    private convertMetadata;
     private generateMDFolderForArtifact;
     private validateDependencyValues;
     /**

package/lib/package/packageVersionCreate.js

@@ -40,6 +40,24 @@ class PackageVersionCreate {
             throw pkgUtils.applyErrorAction(pkgUtils.massageErrorMessage(err));
         }
     }
+    /**
+     * Extracted into a method for UT purposes
+     *
+     * @param componentSet CS to convert
+     * @param outputDirectory where to place the converted MD
+     * @param packageName the packagename related to the CS
+     * @private
+     */
+    // eslint-disable-next-line class-methods-use-this
+    async convertMetadata(componentSet, outputDirectory, packageName) {
+        const converter = new source_deploy_retrieve_1.MetadataConverter();
+        return converter.convert(componentSet, 'metadata', {
+            type: 'directory',
+            outputDirectory,
+            packageName,
+            genUniqueDir: false,
+        });
+    }
     // convert source to mdapi format and copy to tmp dir packaging up
     async generateMDFolderForArtifact(options) {
         const sourcepath = options.sourcePaths ?? [options.sourceDir];
@@ -49,13 +67,7 @@ class PackageVersionCreate {
         });
         const packageName = options.packageName;
         const outputDirectory = path.resolve(options.deploydir);
-        const converter = new source_deploy_retrieve_1.MetadataConverter();
-        const convertResult = await converter.convert(componentSet, 'metadata', {
-            type: 'directory',
-            outputDirectory,
-            packageName,
-            genUniqueDir: false,
-        });
+        const convertResult = await this.convertMetadata(componentSet, outputDirectory, packageName);
         if (packageName) {
             // SDR will build an output path like /output/directory/packageName/package.xml
             // this was breaking from toolbelt, so to revert it we copy the directory up a level and delete the original
@@ -250,10 +262,10 @@ class PackageVersionCreate {
         const clientSideInfo = new Map();
         await fs.promises.mkdir(packageVersBlobDirectory, { recursive: true });
         const settingsGenerator = new scratchOrgSettingsGenerator_1.default({ asDirectory: true });
+        const packageDescriptorJson = (0, kit_1.cloneJson)(this.packageObject);
         // Copy all the metadata from the workspace to a tmp folder
         const componentSet = await this.generateMDFolderForArtifact(mdOptions);
         this.verifyHasSource(componentSet);
-        const packageDescriptorJson = (0, kit_1.cloneJson)(this.packageObject);
         if (packageDescriptorJson.package) {
             delete packageDescriptorJson.package;
             packageDescriptorJson.id = this.packageId;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@salesforce/packaging",
-  "version": "1.0.4",
-  "description": "packing libraries to Salesforce packaging platform",
+  "version": "1.0.5",
+  "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
   "license": "BSD-3-Clause",
+  "repository": "forcedotcom/packaging",
   "scripts": {
     "build": "sf-build",
     "ci-docs": "yarn sf-ci-docs",
@@ -15,7 +16,7 @@
     "format": "sf-format",
     "lint": "sf-lint",
     "lint-fix": "yarn sf-lint --fix",
-    "postcompile": "tsc -p test && tsc -p typedocExamples",
+    "postcompile": "tsc -p test",
     "prepack": "sf-prepack",
     "prepare": "sf-install",
     "pretest": "sf-compile-test",
@@ -26,7 +27,8 @@
     "force",
     "salesforce",
     "sfdx",
-    "salesforcedx"
+    "salesforcedx",
+    "packaging"
   ],
   "files": [
     "docs",
@@ -86,7 +88,6 @@
     "ts-node": "^10.9.1",
     "typescript": "4.8.4"
   },
-  "repository": "forcedotcom/packaging",
   "publishConfig": {
     "access": "public"
   }