ReadonlyapiPrivate ReadonlycomposedPrivate ReadonlyfsPrivate ReadonlyloggerPrivatemdPrivate ReadonlyparsedPrivate ReadonlypluginsPrivaterebuildReadonlytypeStaticdefaultPrivateaddAdds one or more files to the package.
Array of files to add
Optionaltoken: CancellationTokenOptional cancellation token
Instance of the package builder.
PrivateaddAdd file a file to the parsed file set when not already added. Normalizes the file path when required/
file to add
Returns true when the file is nto yet parsed; returns false when the file is already parsed.
Extend the package builder with custom functionality by registering a plugin. Plugins are used to modify package entries during the build process, allowing for custom transformations, as well as filtering or adding new entries.
The provided SalesforcePackageBuilderPlugin instance is appended to the builder's internal plugin list and will be considered during subsequent package build operations.
This method does not perform deduplication or validation of the plugin; callers are responsible for avoiding duplicate registrations if that is undesired.
The plugin to register with the package builder.
void
PrivateaddOptionalcomponentName: stringPrivateaddAdd compressed static resource bundle to the package; compresses all the resources in the folder into a zip file but does not add the meta-data file for the resource folder.
Folder name to add and compress
Gets SalesforcePackage underlying the builder.
Optionaltoken: CancellationTokenPrivatebuildOptionaldata: anyPrivatecompressCompress all files in the specified folder into a single ZIP archive and returns the Buffer to the ZIP archive generated
Folder name to add and compress
PrivatefindPrivatefindPrivategetPrivategetGets a SalesforcePackage containing only the changed components using the provided strategy. TODO: Based on the type of metadata a different strategy should be used instead of the generic one. This will allow for more efficient in delta packaging by using a different API for certain metadata types.
A SalesforcePackage containing only the changed components
PrivategetOptionaltoken: CancellationTokenPrivategetPrivategetGets the SalesforcePackage underlying the builder without rebuilding it.
Use build instead which also rebuilds the package when required (e.g. when replacement tokens are added).
PrivategetGets the name of the component for the package manifest
Retrieves the list of components currently in the package.
An array of SalesforcePackageComponent objects.
PrivategetRetrieves the list of files included in the current metadata package.
An array of file paths representing the files in the package.
PrivategetGet the packaging folder for the source file.
PrivategetPrivategetGet root Element/Tag name of the specified XML file.
Path to the XML file from which to get the root element name.
PrivatemergeMerge the source of the child element into the parent
Source file containing the child source
XML name of the child element
Metadata type of the parent/root
PrivatemergePrivatemergeMerge the source file into the existing package metadata when there is an existing metadata file.
Path of the parent package file in the package
Path of the metedata file on the FS that should be merged into the package
Type of the metadata to merge
PrivatepersistPrivatereadPrivatereadPrivatereadRebuilds the Salesforce metadata package by reinitializing the package instance, clearing any previously parsed files and composed data.
This is automatically called when replacement tokens are added to the package builder after files have been added.
Optionaltoken: CancellationTokenThe current instance for method chaining.
Removes unchanged components from the package by executing the provided delta strategy which determines which components have changed.
The type of the DeltaPackageStrategy.
The type of the object.
An array of removed SalesforcePackageComponent objects.
PrivatesortPrivatestrip
Default API version to use when no version is specified.