Optional fs: FileSystemReadonly apiPrivate Readonly composedPrivate Readonly fsPrivate Readonly loggerPrivate Readonly mdPrivate Readonly metadataPrivate Readonly parsedPrivate Readonly replacementsReadonly typeStatic defaultPrivate addAdds one or more files to the package.
Array of files to add
Optional token: CancellationTokenOptional cancellation token
Instance of the package builder.
Private addAdd a replacement token to the package builder. When building the package the token will be replaced with the replacement value. Replacements are applied to all files in the package and can target specific files or metadata types or be applied globally.
builder.addReplacement({
token: `$CURRENT_USER`
metadataTypes:
});
@remark Avoid applying replacements globally as they can have unintended side effects.
@param replacement
Private addOptional componentName: stringPrivate addAdd 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
Private applyPrivate buildPrivate compressPrivate findPrivate findPrivate getPrivate getGets 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.
Optional strategy: S | (new (...args) => S)The strategy to use for getting the changed components
Optional options: Parameters<S["getChangedComponents"]>[1]Options that are passed to the strategy
A SalesforcePackage containing only the changed components
Private getPrivate getOptional token: CancellationTokenOptional types: string[]SalesforcePackage.getManifest
Private getGets SalesforcePackage underlying the builder.
Private getGets the name of the component for the package manifest
Private getRetrieves the list of components currently in the package.
An array of SalesforcePackageComponent objects.
Private getGet the packaging folder for the source file.
Private getPrivate getPrivate mergeMerge 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
Private mergePrivate mergeMerge 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
Private persistPrivate readPrivate readPrivate readRemoves 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.
Optional strategy: S | (new (...args) => S)The DeltaPackageStrategy instance or constructor.
Optional options: Parameters<S["getChangedComponents"]>[1]The options for getting changed components.
An array of removed SalesforcePackageComponent objects.
Private sortPrivate strip
Default API version to use when no version is specified.