@salesforce/packaging 0.0.48 → 0.1.0

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -211,6 +211,7 @@ export declare type PackageVersionOptions = {
 };
 export declare type ConvertPackageOptions = {
     installationKey: string;
+    definitionfile: string;
     installationKeyBypass: boolean;
     wait: Duration;
     buildInstance: string;

package/lib/package/packageConvert.d.ts

@@ -12,5 +12,6 @@ export declare function convertPackage(pkg: string, connection: Connection, opti
  */
 export declare function createPackageVersionCreateRequest(context: {
     installationkey?: string;
+    definitionfile?: string;
     buildinstance?: string;
-}, packageId: string): Promise<PackagingSObjects.Package2VersionCreateRequest>;
+}, packageId: string, apiVersion: string): Promise<PackagingSObjects.Package2VersionCreateRequest>;

package/lib/package/packageConvert.js

@@ -12,6 +12,7 @@ const os = require("os");
 const fs = require("fs");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
+const scratchOrgSettingsGenerator_1 = require("@salesforce/core/lib/org/scratchOrgSettingsGenerator");
 const uniqid_1 = require("../utils/uniqid");
 const pkgUtils = require("../utils/packageUtils");
 const interfaces_1 = require("../interfaces");
@@ -66,7 +67,12 @@ async function convertPackage(pkg, connection, options, project) {
         maxRetries = (60 / pkgUtils.POLL_INTERVAL_SECONDS) * options.wait.minutes;
     }
     const packageId = await findOrCreatePackage2(pkg, connection);
-    const request = await createPackageVersionCreateRequest({ installationkey: options.installationKey, buildinstance: options.buildInstance }, packageId);
+    const apiVersion = pkgUtils.getSourceApiVersion(project);
+    const request = await createPackageVersionCreateRequest({
+        installationkey: options.installationKey,
+        definitionfile: options.definitionfile,
+        buildinstance: options.buildInstance,
+    }, packageId, apiVersion);
     // TODO: a lot of this is duplicated from PC, PVC, and PVCR.
     const createResult = await connection.tooling.create('Package2VersionCreateRequest', request);
     if (!createResult.success) {
@@ -94,16 +100,52 @@ exports.convertPackage = convertPackage;
  * @returns {{Package2Id: string, Package2VersionMetadata: *, Tag: *, Branch: number}}
  * @private
  */
-async function createPackageVersionCreateRequest(context, packageId) {
+async function createPackageVersionCreateRequest(context, packageId, apiVersion) {
     const uniqueId = (0, uniqid_1.uniqid)({ template: `${packageId}-%s` });
     const packageVersTmpRoot = path.join(os.tmpdir(), uniqueId);
+    const packageVersMetadataFolder = path.join(packageVersTmpRoot, 'md-files');
     const packageVersBlobDirectory = path.join(packageVersTmpRoot, 'package-version-info');
+    const settingsZipFile = path.join(packageVersBlobDirectory, 'settings.zip');
+    const metadataZipFile = path.join(packageVersBlobDirectory, 'package.zip');
     const packageVersBlobZipFile = path.join(packageVersTmpRoot, constants_1.consts.PACKAGE_VERSION_INFO_FILE_ZIP);
     const packageDescriptorJson = {
         id: packageId,
     };
+    const settingsGenerator = new scratchOrgSettingsGenerator_1.default({ asDirectory: true });
+    const definitionFile = context.definitionfile;
+    let definitionFileJson;
+    if (definitionFile) {
+        try {
+            const definitionFilePayload = await fs.promises.readFile(definitionFile, 'utf8');
+            definitionFileJson = JSON.parse(definitionFilePayload);
+        }
+        catch (err) {
+            throw messages.createError('errorReadingDefintionFile', [err]);
+        }
+        // Load any settings from the definition
+        await settingsGenerator.extract(definitionFileJson);
+        if (settingsGenerator.hasSettings() && definitionFileJson.orgPreferences) {
+            // this is not allowed, exit with an error
+            throw messages.createError('signupDuplicateSettingsSpecified');
+        }
+        ['country', 'edition', 'language', 'features', 'orgPreferences', 'snapshot', 'release', 'sourceOrg'].forEach((prop) => {
+            const propValue = definitionFileJson[prop];
+            if (propValue) {
+                packageDescriptorJson[prop] = propValue;
+            }
+        });
+    }
     await fs.promises.mkdir(packageVersTmpRoot, { recursive: true });
     await fs.promises.mkdir(packageVersBlobDirectory, { recursive: true });
+    await fs.promises.mkdir(packageVersMetadataFolder, { recursive: true });
+    await settingsGenerator.createDeploy();
+    await settingsGenerator.createDeployPackageContents(apiVersion);
+    await srcDevUtil.zipDir(`${settingsGenerator.getDestinationPath()}${path.sep}${settingsGenerator.getShapeDirName()}`, settingsZipFile);
+    const shapeDirectory = `${settingsGenerator.getDestinationPath()}${path.sep}${settingsGenerator.getShapeDirName()}`;
+    const currentPackageXml = await fs.promises.readFile(path.join(shapeDirectory, 'package.xml'), 'utf8');
+    await fs.promises.writeFile(path.join(packageVersMetadataFolder, 'package.xml'), currentPackageXml, 'utf-8');
+    // Zip the packageVersMetadataFolder folder and put the zip in {packageVersBlobDirectory}/package.zip
+    await srcDevUtil.zipDir(packageVersMetadataFolder, metadataZipFile);
     await fs.promises.writeFile(path.join(packageVersBlobDirectory, constants_1.consts.PACKAGE2_DESCRIPTOR_FILE), JSON.stringify(packageDescriptorJson, undefined, 2));
     // Zip the Version Info and package.zip files into another zip
     await srcDevUtil.zipDir(packageVersBlobDirectory, packageVersBlobZipFile);

package/lib/utils/packageUtils.d.ts

@@ -23,6 +23,7 @@ export declare const DEFAULT_PACKAGE_DIR: {
 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 getSourceApiVersion(project: SfProject): string;
 export declare function validateIdNoThrow(idObj: Many<IdRegistryValue>, value: any): IdRegistryValue | false;
 export declare function applyErrorAction(err: Error): Error;
 /**

package/lib/utils/packageUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEntry = exports.getPackageAliasesFromId = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getPackageVersionNumber = exports.concatVersion = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = 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;
+exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEntry = exports.getPackageAliasesFromId = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getPackageVersionNumber = exports.concatVersion = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = exports.validateIdNoThrow = exports.getSourceApiVersion = 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.
@@ -58,6 +58,11 @@ function validateId(idObj, value) {
     }
 }
 exports.validateId = validateId;
+function getSourceApiVersion(project) {
+    const apiVersion = project.getSfProjectJson().get('sourceApiVersion');
+    return apiVersion;
+}
+exports.getSourceApiVersion = getSourceApiVersion;
 function validateIdNoThrow(idObj, value) {
     if (!value || (value.length !== 15 && value.length !== 18)) {
         return false;

package/messages/package_version_create.md

@@ -38,6 +38,10 @@ The temp files are located at: %s.
 
 You cannot use 'settings' and 'orgPreferences' in your scratch definition file, please specify one or the other.
 
+# errorReadingDefintionFile
+
+There was an error while reading or parsing the provided scratch definition file: %s
+
 # unpackagedMDDirectoryDoesNotExist
 
 Un-packaged metadata directory %s was specified but does not exist.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.0.48",
+  "version": "0.1.0",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -41,7 +41,7 @@
     "@salesforce/schemas": "^1.2.0",
     "@salesforce/source-deploy-retrieve": "^6.8.2",
     "@salesforce/ts-types": "^1.5.20",
-    "@xmldom/xmldom": "^0.8.2",
+    "@xmldom/xmldom": "^0.8.3",
     "debug": "^4.3.4",
     "globby": "^11",
     "graphology": "^0.25.0",