@salesforce/source-deploy-retrieve

What is @salesforce/source-deploy-retrieve?

@salesforce/source-deploy-retrieve is an npm package that provides tools for interacting with Salesforce metadata. It allows users to retrieve, deploy, and manage Salesforce source code and metadata from a Salesforce org. This package is particularly useful for developers and administrators who need to automate and streamline their Salesforce development and deployment processes.

What are @salesforce/source-deploy-retrieve's main functionalities?

Retrieve Metadata

This feature allows you to retrieve metadata from a Salesforce org. The code sample demonstrates how to use the SourceClient to retrieve metadata for a specific package and save it to an output directory.

const { SourceClient } = require('@salesforce/source-deploy-retrieve');
const client = new SourceClient();
client.retrieve({
  packageNames: ['MyPackage'],
  output: './outputDir'
}).then(result => {
  console.log('Retrieve Result:', result);
}).catch(error => {
  console.error('Error:', error);
});

Deploy Metadata

This feature allows you to deploy metadata to a Salesforce org. The code sample demonstrates how to use the SourceClient to deploy metadata from a specified source directory.

const { SourceClient } = require('@salesforce/source-deploy-retrieve');
const client = new SourceClient();
client.deploy({
  sourcePath: './sourceDir'
}).then(result => {
  console.log('Deploy Result:', result);
}).catch(error => {
  console.error('Error:', error);
});

Convert Metadata

This feature allows you to convert metadata between different formats. The code sample demonstrates how to use the SourceClient to convert metadata from a source directory to an output directory.

const { SourceClient } = require('@salesforce/source-deploy-retrieve');
const client = new SourceClient();
client.convert({
  sourcePath: './sourceDir',
  outputDir: './outputDir'
}).then(result => {
  console.log('Convert Result:', result);
}).catch(error => {
  console.error('Error:', error);
});

Other packages similar to @salesforce/source-deploy-retrieve

sfdx-cli

The sfdx-cli package is the Salesforce CLI, which provides a powerful set of tools for managing Salesforce orgs, including retrieving and deploying metadata. It offers a broader range of functionalities compared to @salesforce/source-deploy-retrieve, including org management, data manipulation, and more.

jsforce

The jsforce package is a JavaScript library for Salesforce API integration. It provides tools for interacting with Salesforce data and metadata, including retrieving and deploying metadata. While it offers similar functionalities to @salesforce/source-deploy-retrieve, it also includes capabilities for working with Salesforce data and performing SOQL queries.

force-dev-tool

The force-dev-tool package is a command-line tool for Salesforce development. It provides functionalities for retrieving, deploying, and managing Salesforce metadata. It is similar to @salesforce/source-deploy-retrieve but is more focused on providing a command-line interface for Salesforce development tasks.

README

Salesforce source-deploy-retrieve

Typescript Library to support the Salesforce extensions for VS Code.

Note: This library is in beta and has been released early so we can collect feedback. It may contain bugs, undergo major changes, or be discontinued.

Development

Clone the project and cd into it. Ensure you have Yarn installed and run the following to build:

yarn build

To test the library in another local module, you can link it to such module so any changes that are built will be automatically present without reinstalling:

yarn local:link /path/to/other/project

to unlink the library:

yarn local:unlink /path/to/other/project

Testing

Running the test suite

yarn test runs the suite and outputs code coverage as a text summary

Testing with the NPM artifact

The library can also be installed to another local project as a regular NPM module. This is useful for manually testing the package that will be deployed to NPM. Use this instead of the linking process that's described under Development to QA changes before they are published:

yarn local:install /path/to/other/package