Class SalesforcePackage

constructor

• new SalesforcePackage(
      apiVersion: string,
      packageDir?: string,
  ): SalesforcePackage

  Create a new metadata package

  Parameters

  • apiVersion: string

    API version of the package

  • packageDir: string = ''

    the package directory, either package or an empty string

  Returns SalesforcePackage

ReadonlyapiVersion

Readonlymanifest

componentsDescription

• get componentsDescription(): string

  Get printable name of the package components for use in the UI. Returns the name of the component in the package if there is only a single component in the package; otherwise returns the component count:

  Returns string

hasDestructiveChanges

• get hasDestructiveChanges(): boolean

  Checl if this package has any destructive changes.

  Returns boolean

  true if the package has destructive changes otherwise false

isEmpty

• get isEmpty(): boolean

  Check if this package is empty; a package is empty if it does not contain any metadata and does not contain any destructive changes.

  Returns boolean

  true if the package is empty otherwise false

add

• add(entry: SalesforcePackageEntry | SalesforcePackageEntry[]): void

  Adds one or more components to the package and updates the package manifest.

  Parameters

  • entry: SalesforcePackageEntry | SalesforcePackageEntry[]

    Package data entry to add

  Returns void

addDestructiveChange

• addDestructiveChange(
      destructiveChange:
          | SalesforceDestructiveChange
          | SalesforceDestructiveChange[],
  ): void

  Adds one or more a destructive change to the package.

  Parameters

  • destructiveChange: SalesforceDestructiveChange | SalesforceDestructiveChange[]

    Destructive change to add

  Returns void

• addDestructiveChange(
      componentType: string,
      componentName: string,
      type?: DestructiveChangeType,
  ): void

  By default, deletions are processed before component additions (pre)

  Parameters

  • componentType: string

    XML Name of the component to delete

  • componentName: string

    Name of the component to delete; cannot be a wild card

  • Optionaltype: DestructiveChangeType

    Type of change can be pre or post, default is pre.

  Returns void

addManifestEntry

• addManifestEntry(component: SalesforcePackageComponent): void

  Add a manifest entry without adding the actual file to the package. You should use setPackageData to add the actual file, or use add to add both the file and the manifest entry.

  Parameters

  • component: SalesforcePackageComponent

    A component to add to the manifest

  Returns void

• addManifestEntry(componentType: string, componentName: string): void

  Add a manifest entry without adding the actual file to the package. You should use setPackageData to add the actual file, or use add to add both the file and the manifest entry.

  Parameters

  • componentType: string

    XML name

  • componentName: string

    Component name

  Returns void

addSourceMap

• addSourceMap(fsPath: string, entry: SalesforcePackageSourceMap): void

  Parameters

  • fsPath: string
  • entry: SalesforcePackageSourceMap

  Returns void

components

• components(
      componentType?: string,
  ): (SalesforcePackageComponent & { files: SalesforcePackageEntry[] })[]

  Get a list of all components in the package optionally filtered by component type.

  Parameters

  • OptionalcomponentType: string

    Component type to filter by or undefined to get all components

  Returns (SalesforcePackageComponent & { files: SalesforcePackageEntry[] })[]

  Array of components in the package and their respective files

files

• files(): Set<string>

  List of paths from the disk from which this package is composed, contains the source files and composed source files.

  Returns Set<string>

  Array of paths to files included in this package

generateArchive

• generateArchive(options?: { fs?: FileSystem }): Promise<__module>

  Builds the ZipArchive from the current package and returns the package archive

  Parameters

  • Optionaloptions: { fs?: FileSystem }

  Returns Promise<__module>

generateMissingMetaFiles

• generateMissingMetaFiles(): void

  Generates missing -meta.xml files for APEX classes using the package specified API version.

  Returns void

getBuffer

• getBuffer(compressionLevel?: number): Promise<Buffer<ArrayBufferLike>>

  Generate a nodejs buffer with compressed package zip that can be uploaded to Salesforce.

  Parameters

  • compressionLevel: number = 4

    levle of compression

  Returns Promise<Buffer<ArrayBufferLike>>

getComponent

• getComponent(
      componentNameOrFullName: string,
  ): SalesforcePackageComponent & { files: SalesforcePackageFileData[] }

  Get a component in the package filtered by component name getting the first component that matches the name ignore the component type. If the specified component name is a full name the type will be extracted from the full name (format: /) and used to filter the component. If the component does not exist in the package the files property will be an empty array.

  Parameters

  • componentNameOrFullName: string

    Name of the component

  Returns SalesforcePackageComponent & { files: SalesforcePackageFileData[] }

  Component matching the specified component name in the package and it's respective files

• getComponent(
      componentType: string,
      componentName: string,
  ): SalesforcePackageComponent & { files: SalesforcePackageFileData[] }

  Get a component in the package filtered by component type and name. If the component does not exist in the package the files property will be an empty array.

  Parameters

  • componentType: string

    Type of the component

  • componentName: string

    Name of the component

  Returns SalesforcePackageComponent & { files: SalesforcePackageFileData[] }

  Component matching the specified component type and name in the package and it's respective files

• getComponent(
      component: SalesforcePackageComponent,
  ): SalesforcePackageComponent & { files: SalesforcePackageFileData[] }

  Get a component in the package filtered by component type and name. If the component does not exist in the package the files property will be an empty array.

  Parameters

  • component: SalesforcePackageComponent

    Component to get specified by type and name

  Returns SalesforcePackageComponent & { files: SalesforcePackageFileData[] }

  Component matching the specified component type and name in the package and it's respective files

getComponentFiles

• getComponentFiles(
      component: SalesforcePackageComponent,
  ): Generator<SalesforcePackageEntry>

  Get all files related to the specified component in the package

  Parameters

  • component: SalesforcePackageComponent

    Component specification for which to get the files

  Returns Generator<SalesforcePackageEntry>

getComponentNames

• getComponentNames(): string[]

  Get a flat array with the names of the components in this package prefixed with their type separated by a slash.

  Returns string[]

  Array of component names in the format /

getComponentSourceFiles

• getComponentSourceFiles(
      component: SalesforcePackageComponent,
  ): undefined | string[]

  Get the sources files associated with the specified component.

  Parameters

  • component: SalesforcePackageComponent

    Component containing componentType and componentName to find sources for *

  Returns undefined | string[]

  FS path from which the component was loaded or undefined when not loaded or not in the current package

getComponentTypes

• getComponentTypes(): string[]

  Get the types of the components in this package.

  Returns string[]

getDestructiveChanges

• getDestructiveChanges(componentType?: string): SalesforceDestructiveChange[]

  Get a list of all destructive changes in the package for the specified component type.

  Parameters

  • OptionalcomponentType: string

    Component type to filter by

  Returns SalesforceDestructiveChange[]

  Array of destructive changes matching the specified component type

getManifest

• getManifest(metadataTypes?: string[]): PackageManifest

  Gets a new package manifest with just the specified metadata types. If no metadata types are specified a copy of the current manifest is returned.

  Parameters

  • OptionalmetadataTypes: string[]

    Metadata types to filter by or undefined (default) to get all metadata types

  Returns PackageManifest

getPackageData

• getPackageData(
      packagePath: string,
  ): undefined | { data?: string | Buffer<ArrayBufferLike>; fsPath?: string }

  Get the currently packaged data for the specified path in the package.

  Parameters

  • packagePath: string

    Package path

  Returns undefined | { data?: string | Buffer<ArrayBufferLike>; fsPath?: string }

getPackageMetadata

• getPackageMetadata<T extends object = Record<string, any>>(
      component: SalesforcePackageComponent,
  ): undefined | T

  Try to read the metadata associated to the specified component by type and name.

  Type Parameters

  • T extends object = Record<string, any>

  Parameters

  • component: SalesforcePackageComponent

  Returns undefined | T

  Parsed XML metadata associated to the component as defined in the package

• getPackageMetadata<T extends object = Record<string, any>>(
      type: string,
      name: string,
  ): undefined | T

  Try to read the metadata associated to the specified component by type and name.

  Type Parameters

  • T extends object = Record<string, any>

  Parameters

  • type: string
  • name: string

  Returns undefined | T

  Parsed XML metadata associated to the component as defined in the package

getPackagePaths

• getPackagePaths(component: SalesforcePackageComponent): string[]

  Get all package paths for the specified component. Use this method to get all files in the package for a specific component. * Use getPackageData to get the actual data for the package path at the specified path.

  Parameters

  • component: SalesforcePackageComponent

    Component to get package paths for

  Returns string[]

getSourceFile

• getSourceFile(packagePath: string): undefined | string

  Get the source file for any package path in the package.

  Parameters

  • packagePath: string

    package path

  Returns undefined | string

  Source file FS path

getSourceFileInfo

• getSourceFileInfo(sourceFile: string): undefined | SalesforcePackageSourceMap

  Returns source file info such as the detected component type as well as package path for each source file.

  Parameters

  • sourceFile: string

    Source file path

  Returns undefined | SalesforcePackageSourceMap

getSourceFiles

• getSourceFiles(packagePath: string): undefined | string[]

  Retrieves the source files associated with a specific package path.

  Parameters

  • packagePath: string

    The path to the package whose source files are to be retrieved.

  Returns undefined | string[]

  The source files mapped to the component identified by the package entry, or undefined if the package entry does not exist.

getSourceFolder

• getSourceFolder(
      componentType: string,
      componentName: string,
  ): undefined | string

  Get source folder containing the specified component.

  Parameters

  • componentType: string

    Type of the component

  • componentName: string

    Name of the component, or its full name in the form <type>/<name>

  Returns undefined | string

  Source file folder or undefined when not found

getTestClasses

• getTestClasses(): string[]

  Get a list of all unit test classes that have been added to the current package. Detects test classes based on class and test method annotations.

  When a file system is specified the file system is used to read the file contents if the file is not already loaded. In this case the method will return a promise. Otherwise the method will return a string array with the names of the test classes.

  Returns string[]

• getTestClasses(options: { fs: FileSystem }): Promise<string[]>

  Get a list of all unit test classes that have been added to the current package. Detects test classes based on class and test method annotations.

  When a file system is specified the file system is used to read the file contents if the file is not already loaded. In this case the method will return a promise. Otherwise the method will return a string array with the names of the test classes.

  Parameters

  • options: { fs: FileSystem }

  Returns Promise<string[]>

hasPackageData

• hasPackageData(packagePath: string): boolean

  Determine if a file exists in the current packahge

  Parameters

  • packagePath: string

    Path of file in package

  Returns boolean

merge

• merge(otherPackage: SalesforcePackage): SalesforcePackage

  Merge this package with another package and returns this

  Parameters

  • otherPackage: SalesforcePackage

    Package to merge

  Returns SalesforcePackage

mergeDestructiveChanges

• mergeDestructiveChanges(
      manifestSource: string | Buffer<ArrayBufferLike>,
      type?: DestructiveChangeType,
  ): void

  Merge an existing destructive changes XML into the package as pre or post change.

  Parameters

  • manifestSource: string | Buffer<ArrayBufferLike>

    Source file

  • type: DestructiveChangeType = 'pre'

    Type of changes

  Returns void

remove

• remove(entry: SalesforcePackageComponent): void

  Removes all package data from the package for the specified component.

  Parameters

  • entry: SalesforcePackageComponent

    The component to remove.

  Returns void

setPackageData

• setPackageData(
      packagePath: string,
      data: Partial<SalesforcePackageFileData>,
  ): void

  Merges or set the package data for the file at the specified package path.

  Parameters

  • packagePath: string

    Package path to override

  • data: Partial<SalesforcePackageFileData>

    Data to set

  Returns void

size

• size(): number

  Counts the number of unique components in this package.

  Returns number

sourceFiles

• sourceFiles(): Generator<{ fsPath: string; packagePath: string }, void, unknown>

  Get a list of paths to files included in this package and the respective files on the file system from which they were generated.

  Returns Generator<{ fsPath: string; packagePath: string }, void, unknown>

writeToFile

• writeToFile(filePath: string, compressionLevel?: number): Promise<void>

  Writes the package content to a file at the specified path with optional compression

  Parameters

  • filePath: string

    The path where the file will be written

  • compressionLevel: number = 4

    The level of compression to apply (0-9, where 0 is no compression and 9 is maximum compression), default is 4

  Returns Promise<void>

  A Promise that resolves when the file has been successfully written