@salesforce/core

What is @salesforce/core?

@salesforce/core is a powerful npm package designed to facilitate interaction with Salesforce's APIs and services. It provides a set of tools and utilities for managing Salesforce authentication, configuration, and API requests, making it easier for developers to build and manage Salesforce applications.

What are @salesforce/core's main functionalities?

Authentication

This feature allows you to authenticate to a Salesforce org using a username. The code sample demonstrates how to create an AuthInfo object and establish a connection to Salesforce.

const { AuthInfo } = require('@salesforce/core');

async function authenticate() {
  const authInfo = await AuthInfo.create({ username: 'your-username' });
  const connection = await authInfo.getConnection();
  console.log('Authenticated to Salesforce:', connection.instanceUrl);
}
authenticate();

Configuration Management

This feature provides tools for managing and retrieving Salesforce configuration settings. The code sample shows how to create a ConfigAggregator and retrieve the current configuration.

const { ConfigAggregator } = require('@salesforce/core');

async function getConfig() {
  const configAggregator = await ConfigAggregator.create();
  const config = configAggregator.getConfig();
  console.log('Salesforce Configuration:', config);
}
getConfig();

API Requests

This feature allows you to make API requests to Salesforce. The code sample demonstrates how to create a connection and perform a SOQL query to retrieve data from Salesforce.

const { Connection } = require('@salesforce/core');

async function querySalesforce() {
  const connection = await Connection.create({ authInfo: await AuthInfo.create({ username: 'your-username' }) });
  const result = await connection.query('SELECT Id, Name FROM Account');
  console.log('Query Result:', result.records);
}
querySalesforce();

Other packages similar to @salesforce/core

jsforce

Jsforce is a popular library for interacting with Salesforce APIs. It provides a comprehensive set of features for authentication, CRUD operations, and more. Compared to @salesforce/core, jsforce offers a more extensive set of functionalities and is widely used in the Salesforce developer community.

nforce

Nforce is another library for working with Salesforce APIs. It focuses on providing a simple and intuitive interface for performing CRUD operations and managing authentication. While it may not be as feature-rich as @salesforce/core, it is known for its ease of use and simplicity.

README

Salesforce DX Core Library (Beta)

This library provides client-side management of Salesforce DX projects, org authentication, connections to Salesforce APIs, and other various utilities.

See the API documentation.

---

As a beta feature, Salesforce Core Libraries is a preview and isn’t part of the “Services” under your master subscription agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature.

---