@salesforce/packaging 4.1.13 → 4.1.14-dev.0

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -26,7 +26,7 @@ export type IPackageVersion2GP = {
 };
 export type PackageOptions = {
     connection: Connection;
-    project: SfProject;
+    project?: SfProject;
     packageAliasOrId: string;
 };
 export type PackageUpdateOptions = {
@@ -232,7 +232,7 @@ export type PackageVersionOptions = {
      * 3. Alias for a 04t or 05i, defined in sfdx-project.json
      */
     idOrAlias: string;
-    project: SfProject;
+    project?: SfProject;
 };
 export type SubscriberPackageVersionOptions = {
     connection: Connection;
@@ -342,7 +342,7 @@ export type PackageAncestryNodeData = {
 };
 export type PackageAncestryOptions = {
     packageId: string;
-    project: SfProject;
+    project?: SfProject;
     connection: Connection;
 };
 export type AncestryRepresentationProducerOptions = {

package/lib/package/package.d.ts

@@ -51,7 +51,7 @@ export declare class Package {
      * @param project - instance of SfProject
      * @param options - see {@link PackageVersionListOptions}
      */
-    static listVersions(connection: Connection, project: SfProject, options?: PackageVersionListOptions): Promise<PackageVersionListResult[]>;
+    static listVersions(connection: Connection, project?: SfProject, options?: PackageVersionListOptions): Promise<PackageVersionListResult[]>;
     /**
      * create a PackageAncestry instance
      *
@@ -59,7 +59,7 @@ export declare class Package {
      * @param project SfProject instance
      * @param connection Hub Org Connection
      */
-    static getAncestry(packageId: string, project: SfProject, connection: Connection): Promise<PackageAncestry>;
+    static getAncestry(packageId: string, project: SfProject | undefined, connection: Connection): Promise<PackageAncestry>;
     /**
      * Convert a 1st generation package to a 2nd generation package.
      * See {@link ConvertPackageOptions} for conversion options.

package/lib/package/package.js

@@ -62,8 +62,9 @@ class Package {
         this.options = options;
         let packageId = this.options.packageAliasOrId;
         if (!packageId.startsWith(packagePrefixes.PackageId)) {
-            packageId =
-                this.options.project.getPackageIdFromAlias(this.options.packageAliasOrId) ?? this.options.packageAliasOrId;
+            packageId = this.options.project
+                ? this.options.project.getPackageIdFromAlias(this.options.packageAliasOrId) ?? this.options.packageAliasOrId
+                : this.options.packageAliasOrId;
             if (packageId === this.options.packageAliasOrId) {
                 throw messages.createError('packageAliasNotFound', [this.options.packageAliasOrId]);
             }
@@ -107,7 +108,7 @@ class Package {
     static async listVersions(connection, project, options) {
         // resolve/verify packages
         const packages = options?.packages?.map((pkg) => {
-            const id = project.getPackageIdFromAlias(pkg) ?? pkg;
+            const id = project ? project.getPackageIdFromAlias(pkg) ?? pkg : pkg;
             // validate ID
             if (id.startsWith('0Ho')) {
                 (0, packageUtils_1.validateId)(packageUtils_1.BY_LABEL.PACKAGE_ID, id);

package/lib/package/packageAncestry.js

@@ -200,7 +200,9 @@ class PackageAncestry extends kit_1.AsyncCreatable {
     }
     async getRootsFromRequestedId() {
         let roots = [];
-        this.packageId = this.options.project.getPackageIdFromAlias(this.options.packageId) ?? this.options.packageId;
+        this.packageId = this.options.project
+            ? this.options.project.getPackageIdFromAlias(this.options.packageId) ?? this.options.packageId
+            : this.options.packageId;
         switch (this.requestedPackageId?.slice(0, 3)) {
             case '0Ho':
                 pkgUtils.validateId(pkgUtils.BY_LABEL.PACKAGE_ID, this.requestedPackageId);

package/lib/package/packageDelete.d.ts

@@ -1,3 +1,3 @@
 import { Connection, SfProject } from '@salesforce/core';
 import { PackageSaveResult } from '../interfaces';
-export declare function deletePackage(idOrAlias: string, project: SfProject, connection: Connection, undelete: boolean): Promise<PackageSaveResult>;
+export declare function deletePackage(idOrAlias: string, project: SfProject | undefined, connection: Connection, undelete: boolean): Promise<PackageSaveResult>;

package/lib/package/packageDelete.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deletePackage = deletePackage;
 const packageUtils_1 = require("../utils/packageUtils");
 async function deletePackage(idOrAlias, project, connection, undelete) {
-    const packageId = project.getPackageIdFromAlias(idOrAlias) ?? idOrAlias;
+    const packageId = project ? project.getPackageIdFromAlias(idOrAlias) ?? idOrAlias : idOrAlias;
     (0, packageUtils_1.validateId)(packageUtils_1.BY_LABEL.PACKAGE_ID, packageId);
     const request = { Id: packageId, IsDeprecated: !undelete };
     const updateResult = await connection.tooling.update('Package2', request).catch((err) => {

package/lib/package/packageVersion.d.ts

@@ -45,7 +45,7 @@ export type Package2VersionQueryOptions = {
  */
 export declare class PackageVersion {
     private options;
-    private readonly project;
+    private readonly project?;
     private readonly connection;
     private data?;
     private packageType?;

package/lib/package/packageVersion.js

@@ -510,6 +510,9 @@ class PackageVersion {
         return updateResult;
     }
     async updateProjectWithPackageVersion(results) {
+        if (!this.project) {
+            throw new core_1.SfError('errors.RequiresProject');
+        }
         if (!kit_1.env.getBoolean('SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE')) {
             // get the newly created package version from the server
             const versionResult = (await this.connection.tooling.query(`SELECT Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber FROM Package2Version WHERE SubscriberPackageVersionId='${results.SubscriberPackageVersionId ?? ''}'`)).records[0];
@@ -533,7 +536,9 @@ class PackageVersion {
         }
     }
     resolveId() {
-        return this.project.getPackageIdFromAlias(this.options.idOrAlias) ?? this.options.idOrAlias;
+        return this.project
+            ? this.project.getPackageIdFromAlias(this.options.idOrAlias) ?? this.options.idOrAlias
+            : this.options.idOrAlias;
     }
 }
 exports.PackageVersion = PackageVersion;

package/lib/package/packageVersionReport.d.ts

@@ -3,6 +3,6 @@ import { PackageVersionReportResult } from '../interfaces';
 export declare function getPackageVersionReport(options: {
     packageVersionId: string;
     connection: Connection;
-    project: SfProject;
+    project?: SfProject;
     verbose: boolean;
 }): Promise<PackageVersionReportResult[]>;

package/messages/package_version.md

@@ -21,3 +21,9 @@ Could not fetch the subscriber package version ID (04t).
 # maxPackage2VersionRecords
 
 The maximum result size (2000) was reached when querying the Package2Version SObject. This means there could be more records that were not returned by the query. If all records are required you may have to break the query into multiple requests filtered by date, then aggregate the results.
+
+# errors.RequiresProject
+
+This method expects an sfdx project to be available to write the new package version data in it.
+Make sure to pass `options.project` when instantiating `PackageVersion`.
+https://forcedotcom.github.io/packaging/classes/package_packageVersion.PackageVersion.html#constructor

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.1.13",
+  "version": "4.1.14-dev.0",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",