Class Package

Provides the ability to list, create, update, delete, convert, and get version ancestry for a 2nd generation package.

Examples

Create a new instance and get the ID (0Ho):

const id = new Package({connection, project, packageOrAliasId}).getId();

Create a new package in the org:

const myPkg = await Package.create(connection, project, options);

List all packages in the org:

const pkgList = await Package.list(connection);

Index

Constructors

constructor

Methods

delete getId getPackageData getPackageVersions getType undelete update convert create downloadPackageVersionMetadata getAncestry getDependencyGraph list listVersions

Constructors

constructor

new Package(options: PackageOptions): Package
Parameters
- options: PackageOptions
Returns Package
- Defined in package/package.ts:98

Methods

delete

delete(): Promise<SaveResult>
Deletes the package.

Returns Promise<SaveResult>
- Defined in package/package.ts:300

getId

getId(): string
Returns the package ID of the package.

Returns string
package ID (0Ho)
- Defined in package/package.ts:265

getPackageData

getPackageData(force?: boolean): Promise<Package2 | undefined>
Returns the package data for the package.
Parameters
- force: boolean = false
  force a refresh of the package data
Returns Promise<Package2 | undefined>
- Defined in package/package.ts:367

getPackageVersions

getPackageVersions(
options?: PackageVersionListOptions,
): Promise<PackageVersionListResult[]>
Returns the list of package versions for the package. See PackageVersionListOptions for list options
Parameters
- Optionaloptions: PackageVersionListOptions
Returns Promise<PackageVersionListResult[]>
- Defined in package/package.ts:285

getType

getType(): Promise<PackageType | undefined>
Returns the package type of the package.

Returns Promise<PackageType | undefined>
- Defined in package/package.ts:274

undelete

undelete(): Promise<SaveResult>
Un-Deletes the package.

Returns Promise<SaveResult>
- Defined in package/package.ts:308

update

update(
options: PackageUpdateOptions,
skipAncestorCheck?: boolean,
): Promise<SaveResult>
Updates the package using the values defined in the options. See PackageUpdateOptions for update options.
Parameters
- options: PackageUpdateOptions
- OptionalskipAncestorCheck: boolean
Returns Promise<SaveResult>
- Defined in package/package.ts:318

`Static`convert

convert(
    pkgId: string,
    connection: Connection,
    options: ConvertPackageOptions,
    project?: SfProject,
): Promise<PackageVersionCreateRequestResult>
Convert a 1st generation package to a 2nd generation package. See ConvertPackageOptions for conversion options.
Parameters
- pkgId: string
  the 1GP package ID (033) of the package to convert
- connection: Connection
- options: ConvertPackageOptions
  ConvertPackageOptions
- Optionalproject: SfProject
Returns Promise<PackageVersionCreateRequestResult>
- Defined in package/package.ts:228

`Static`create

create(
    connection: Connection,
    project: SfProject,
    options: PackageCreateOptions,
): Promise<{ Id: string }>
Create a new package.
Parameters
- connection: Connection
  instance of Connection
- project: SfProject
  instance of SfProject
- options: PackageCreateOptions
  options for creating a package - see PackageCreateOptions
Returns Promise<{ Id: string }>
Package
- Defined in package/package.ts:124

`Static`downloadPackageVersionMetadata

downloadPackageVersionMetadata(
    project: SfProject,
    options: PackageVersionMetadataDownloadOptions,
    connection: Connection,
): Promise<ConvertResult>
Download the metadata files for a previously published package version, convert them to source format, and put them into a new project folder within the sfdx project.
Parameters
- project: SfProject
- options: PackageVersionMetadataDownloadOptions
  PackageVersionMetadataDownloadOptions
- connection: Connection
Returns Promise<ConvertResult>
- Defined in package/package.ts:245

`Static`getAncestry

getAncestry(
    packageId: string,
    project: SfProject | undefined,
    connection: Connection,
): Promise<PackageAncestry>
create a PackageAncestry instance
Parameters
- packageId: string
  to get version information for
- project: SfProject | undefined
  SfProject instance
- connection: Connection
  Hub Org Connection
Returns Promise<PackageAncestry>
- Defined in package/package.ts:183

`Static`getDependencyGraph

getDependencyGraph(
    packageVersionId: string,
    project: SfProject | undefined,
    connection: Connection,
    options?: {
        edgeDirection?: "root-first" | "root-last";
        installationKey?: string;
        verbose?: boolean;
    },
): Promise<PackageVersionDependency>
create a PackageVersionDependency instance
Parameters
- packageVersionId: string
  to get version information for
- project: SfProject | undefined
  SfProject instance
- connection: Connection
  Hub Org Connection
- Optionaloptions: {
      edgeDirection?: "root-first" | "root-last";
      installationKey?: string;
      verbose?: boolean;
  }
  flags for the command line
Returns Promise<PackageVersionDependency>
- Defined in package/package.ts:203

`Static`list

list(connection: Connection): Promise<Package2[]>
Returns all the packages that are available in the org, up to 10,000. If more records are needed use the SF_ORG_MAX_QUERY_LIMIT env var.
Parameters
- connection: Connection
Returns Promise<Package2[]>
- Defined in package/package.ts:138

`Static`listVersions

listVersions(
    connection: Connection,
    project?: SfProject,
    options?: PackageVersionListOptions,
): Promise<PackageVersionListResult[]>
Returns the package versions in the org. See PackageVersionListOptions for list options
Parameters
- connection: Connection
  connection to the org
- Optionalproject: SfProject
  instance of SfProject
- Optionaloptions: PackageVersionListOptions
  see PackageVersionListOptions
Returns Promise<PackageVersionListResult[]>
- Defined in package/package.ts:153

Class Package

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Package

Methods

delete

Returns Promise<SaveResult>

getId

Returns string

getPackageData

Parameters

Returns Promise<Package2 | undefined>

getPackageVersions

Parameters

Returns Promise<PackageVersionListResult[]>

getType

Returns Promise<PackageType | undefined>

undelete

Returns Promise<SaveResult>

update

Parameters

Returns Promise<SaveResult>

Staticconvert

Parameters

Returns Promise<PackageVersionCreateRequestResult>

Staticcreate

Parameters

Returns Promise<{ Id: string }>

StaticdownloadPackageVersionMetadata

Parameters

Returns Promise<ConvertResult>

StaticgetAncestry

Parameters

Returns Promise<PackageAncestry>

StaticgetDependencyGraph

Parameters

Returns Promise<PackageVersionDependency>

Staticlist

Parameters

Returns Promise<Package2[]>

StaticlistVersions

Parameters

Returns Promise<PackageVersionListResult[]>

Settings

On This Page

`Static`convert

`Static`create

`Static`downloadPackageVersionMetadata

`Static`getAncestry

`Static`getDependencyGraph

`Static`list

`Static`listVersions