@salesforce/packaging 1.4.16 → 1.4.17

package/lib/interfaces/packagingInterfacesAndType.d.ts

@@ -135,23 +135,23 @@ export type PackageDescriptorJson = Partial<NamedPackageDir> & Partial<{
 export type PackageVersionCreateRequest = {
     Package2Id: string;
     VersionInfo: string;
-    Tag: string;
-    Branch: string;
-    InstallKey: string;
-    Instance: string;
-    SourceOrg: string;
+    Tag?: string;
+    Branch?: string;
+    InstallKey?: string;
+    Instance?: string;
+    SourceOrg?: string;
     Language?: string;
     CalculateCodeCoverage: boolean;
     SkipValidation: boolean;
 };
 export type PackageVersionListOptions = {
-    orderBy: string;
-    modifiedLastDays: number;
-    createdLastDays: number;
-    packages: string[];
-    verbose: boolean;
-    concise: boolean;
-    isReleased: boolean;
+    orderBy?: string;
+    modifiedLastDays?: number;
+    createdLastDays?: number;
+    packages?: string[];
+    verbose?: boolean;
+    concise?: boolean;
+    isReleased?: boolean;
 };
 export type PackageVersionUpdateOptions = {
     InstallKey?: string;
@@ -160,9 +160,6 @@ export type PackageVersionUpdateOptions = {
     Branch?: string;
     Tag?: string;
 };
-export type ListPackageVersionOptions = PackageVersionListOptions & {
-    connection: Connection;
-};
 export type PackageSaveResult = SaveResult;
 export type PackageVersionCreateRequestOptions = {
     path: string;
@@ -259,7 +256,6 @@ export type PackageVersionCreateOptions = {
 }>;
 export type PackageVersionCreateRequestQueryOptions = {
     createdlastdays?: number;
-    connection?: Connection;
     status?: 'Queued' | 'InProgress' | 'Success' | 'Error';
     id?: string;
 };
@@ -268,12 +264,17 @@ export type ProfileApiOptions = {
     includeUserLicenses: boolean;
     generateProfileInformation: boolean;
 };
-export type PackageVersionReportResult = Partial<PackagingSObjects.Package2Version> & {
-    Package2: Partial<PackagingSObjects.Package2>;
+export type PackageVersionReportResult = Partial<Omit<PackagingSObjects.Package2Version, 'AncestorId' | 'HasPassedCodeCoverageCheck' | 'HasMetadataRemoved'>> & {
+    Package2: Partial<Omit<PackagingSObjects.Package2, 'IsOrgDependent'>> & {
+        IsOrgDependent: boolean | null | undefined;
+    };
     SubscriberPackageVersion?: Pick<PackagingSObjects.SubscriberPackageVersion, 'Dependencies'>;
     Version: string;
-    AncestorVersion?: string;
-    PackageType: PackageType;
+    AncestorVersion?: string | null;
+    AncestorId?: string | null;
+    PackageType?: PackageType | null;
+    HasPassedCodeCoverageCheck?: boolean | null;
+    HasMetadataRemoved?: boolean | null;
 };
 export type PackageVersionCreateReportProgress = PackageVersionCreateRequestResult & {
     remainingWaitTime: Duration;
@@ -300,14 +301,17 @@ export type CodeCoveragePercentages = null | {
 };
 export type PackageAncestryNodeOptions = Attributes & {
     AncestorId?: string;
-    SubscriberPackageVersionId?: string;
-    MajorVersion?: string | number;
-    MinorVersion?: string | number;
-    PatchVersion?: string | number;
-    BuildNumber?: string | number;
-    depthCounter?: number;
-};
-export type PackageAncestryData = Omit<PackageAncestryNodeOptions, 'AncestorId'>;
+    SubscriberPackageVersionId: string;
+    MajorVersion: string | number;
+    MinorVersion: string | number;
+    PatchVersion: string | number;
+    BuildNumber: string | number;
+    depthCounter: number;
+};
+export type PackageAncestryNodeAttributes = PackageAncestryNodeOptions & {
+    node: PackageAncestryNode;
+};
+export type PackageAncestryData = Omit<PackageAncestryNodeAttributes, 'AncestorId'>;
 export type PackageAncestryNodeData = {
     data: PackageAncestryNodeOptions;
     children: PackageAncestryNodeData[];
@@ -318,16 +322,16 @@ export type PackageAncestryOptions = {
     connection: Connection;
 };
 export type AncestryRepresentationProducerOptions = {
-    [key: string]: unknown;
-    node: PackageAncestryNode;
-    depth?: number;
+    packageNode?: PackageAncestryNode;
+    depth: number;
     verbose?: boolean;
+    logger?: (text: string) => void;
 };
 export interface AncestryRepresentationProducer {
     label: string;
-    options: AncestryRepresentationProducerOptions;
+    options?: AncestryRepresentationProducerOptions;
     addNode(node: AncestryRepresentationProducer): void;
-    produce<T>(): T | string | void;
+    produce(): PackageAncestryNodeData | string | void;
 }
 export declare const PackageEvents: {
     convert: {

package/lib/package/package.d.ts

@@ -23,7 +23,7 @@ export declare const Package2Fields: string[];
 export declare class Package {
     private options;
     private readonly packageId;
-    private packageData;
+    private packageData?;
     constructor(options: PackageOptions);
     /**
      * Create a new package.
@@ -80,7 +80,7 @@ export declare class Package {
      *
      * @returns {Promise<PackageType>}
      */
-    getType(): Promise<PackageType>;
+    getType(): Promise<PackageType | undefined>;
     /**
      * Returns the list of package versions for the package.
      * See {@link PackageVersionListOptions} for list options
@@ -111,5 +111,5 @@ export declare class Package {
      *
      * @param force force a refresh of the package data
      */
-    getPackageData(force?: boolean): Promise<PackagingSObjects.Package2>;
+    getPackageData(force?: boolean): Promise<PackagingSObjects.Package2 | undefined>;
 }

package/lib/package/package.js

@@ -119,9 +119,9 @@ class Package {
                 throw messages.createError('invalidPackageId', [id, '0Ho']);
             }
         });
-        const opts = options || {};
-        opts.packages = packages || [];
-        return (await (0, packageVersionList_1.listPackageVersions)({ ...opts, ...{ connection } })).records;
+        const opts = options ?? {};
+        opts.packages = packages ?? [];
+        return (await (0, packageVersionList_1.listPackageVersions)(connection, opts)).records;
     }
     /**
      * create a PackageAncestry instance
@@ -163,7 +163,7 @@ class Package {
      * @returns {Promise<PackageType>}
      */
     async getType() {
-        return (await this.getPackageData()).ContainerOptions;
+        return (await this.getPackageData())?.ContainerOptions;
     }
     /**
      * Returns the list of package versions for the package.
@@ -204,15 +204,18 @@ class Package {
     async update(options) {
         try {
             // filter out any undefined values and their keys
-            Object.keys(options).forEach((key) => options[key] === undefined && delete options[key]);
-            const result = await this.options.connection.tooling.update('Package2', options);
+            const opts = Object.fromEntries(Object.entries(options).filter(([, value]) => value !== undefined));
+            const result = await this.options.connection.tooling.update('Package2', opts);
             if (!result.success) {
                 throw new core_1.SfError(result.errors.join(', '));
             }
             return result;
         }
         catch (err) {
-            throw (0, packageUtils_1.applyErrorAction)((0, packageUtils_1.massageErrorMessage)(err));
+            if (err instanceof Error) {
+                throw (0, packageUtils_1.applyErrorAction)((0, packageUtils_1.massageErrorMessage)(err));
+            }
+            throw err;
         }
     }
     /**
@@ -221,10 +224,13 @@ class Package {
      * @param force force a refresh of the package data
      */
     async getPackageData(force = false) {
-        if (!this.packageData || force) {
+        if (!this.packageData ?? force) {
             this.packageData = (await this.options.connection.tooling
                 .sobject('Package2')
                 .retrieve(this.packageId));
+            if (!this.packageData) {
+                throw messages.createError('packageNotFound', [this.packageId]);
+            }
         }
         return this.packageData;
     }

package/lib/package/packageAncestry.d.ts

@@ -1,25 +1,25 @@
 import { DirectedGraph } from 'graphology';
 import { AsyncCreatable } from '@salesforce/kit';
 import { Tree } from '@oclif/core/lib/cli-ux/styled/tree';
-import { Attributes } from 'graphology-types';
-import { AncestryRepresentationProducer, AncestryRepresentationProducerOptions, PackageAncestryNodeOptions, PackageAncestryOptions } from '../interfaces';
+import { AncestryRepresentationProducer, AncestryRepresentationProducerOptions, PackageAncestryNodeData, PackageAncestryNodeOptions, PackageAncestryOptions } from '../interfaces';
 import { VersionNumber } from './versionNumber';
 /**
  * A class that represents the package ancestry graph.
  * Given a package Id (0Ho) or a package version Id (04t), it will build a graph of the package's ancestors.
  */
 export declare class PackageAncestry extends AsyncCreatable<PackageAncestryOptions> {
-    #private;
     private options;
-    private graph;
     private roots;
+    private graph;
+    private packageId;
     constructor(options: PackageAncestryOptions);
-    get requestedPackageId(): string;
+    get requestedPackageId(): string | undefined;
+    private static createAttributes;
     init(): Promise<void>;
     /**
      * Returns the internal representation of the requested package ancestry graph.
      */
-    getAncestryGraph(): DirectedGraph<Attributes, Attributes, Attributes>;
+    getAncestryGraph(): DirectedGraph;
     /**
      * Convenience method to get the json representation of the package ancestry graph.
      */
@@ -36,9 +36,9 @@ export declare class PackageAncestry extends AsyncCreatable<PackageAncestryOptio
      * Returns the producer representation of the package ancestry graph.
      *
      * @param producerCtor - function that returns a new instance of the producer
-     * @param root - the subscriber package version id of the root node
+     * @param rootPackageId - the subscriber package version id of the root node
      */
-    getRepresentationProducer(producerCtor: (options?: AncestryRepresentationProducerOptions) => AncestryRepresentationProducer, root: string | undefined): AncestryRepresentationProducer;
+    getRepresentationProducer(producerCtor: (options: AncestryRepresentationProducerOptions) => AncestryRepresentationProducer, rootPackageId: string | undefined): AncestryRepresentationProducer;
     /**
      * Returns a list of ancestry nodes that represent the path from subscriber package version id to the root of the
      * package ancestry tree.
@@ -47,7 +47,7 @@ export declare class PackageAncestry extends AsyncCreatable<PackageAncestryOptio
      */
     getLeafPathToRoot(subscriberPackageVersionId?: string): PackageAncestryNode[][];
     private buildAncestryTree;
-    private getRoots;
+    private getRootsFromRequestedId;
     private findRootsForPackageVersion;
     private validatePackageType;
     private getPackageVersion;
@@ -59,8 +59,8 @@ export declare class PackageAncestry extends AsyncCreatable<PackageAncestryOptio
 }
 export declare class AncestryTreeProducer extends Tree implements AncestryRepresentationProducer {
     label: string;
-    options: AncestryRepresentationProducerOptions;
-    private verbose;
+    options?: AncestryRepresentationProducerOptions;
+    private readonly verbose;
     constructor(options?: AncestryRepresentationProducerOptions);
     addNode(node: AncestryTreeProducer): void;
     produce(): void;
@@ -68,16 +68,16 @@ export declare class AncestryTreeProducer extends Tree implements AncestryRepres
 }
 export declare class AncestryJsonProducer implements AncestryRepresentationProducer {
     label: string;
-    options: AncestryRepresentationProducerOptions;
+    options?: AncestryRepresentationProducerOptions;
     private children;
     private readonly data;
-    constructor(options?: AncestryRepresentationProducerOptions);
+    constructor(options: AncestryRepresentationProducerOptions);
     addNode(node: AncestryJsonProducer): void;
-    produce<PackageAncestryNodeData>(): PackageAncestryNodeData;
+    produce(): PackageAncestryNodeData;
 }
 export declare class AncestryDotProducer implements AncestryRepresentationProducer {
     label: string;
-    options: AncestryRepresentationProducerOptions;
+    options?: AncestryRepresentationProducerOptions;
     private children;
     constructor(options?: AncestryRepresentationProducerOptions);
     /**
@@ -96,18 +96,17 @@ export declare class AncestryDotProducer implements AncestryRepresentationProduc
     addNode(node: AncestryDotProducer): void;
     produce(): string;
 }
-export declare class PackageAncestryNode extends AsyncCreatable<PackageAncestryNodeOptions> implements Attributes {
-    #private;
+export declare class PackageAncestryNode extends AsyncCreatable<PackageAncestryNodeOptions> {
     options: PackageAncestryNodeOptions;
+    readonly version: VersionNumber;
+    readonly MajorVersion: number;
+    readonly MinorVersion: number;
+    readonly PatchVersion: number;
+    readonly BuildNumber: number | string;
+    readonly AncestorId: string | undefined;
+    readonly SubscriberPackageVersionId: string;
+    readonly depthCounter = 0;
     constructor(options: PackageAncestryNodeOptions);
-    get AncestorId(): string;
-    get SubscriberPackageVersionId(): string;
-    get version(): VersionNumber;
-    get MinorVersion(): number;
-    get PatchVersion(): number;
-    get BuildNumber(): number | string;
-    get MajorVersion(): number;
-    get depthCounter(): number;
     getVersion(): string;
     protected init(): Promise<void>;
 }