@aurahelper/connector
Advanced tools
Powerfull Libraries to connect with Salesforce to list, describe, deploy or retrieve metadata types. Also can describe SObjects, Create Projects, Authorize Orgs, Execute Queries, Export or Import Data... To the correct work of this library, you need to ha
Module to connect with Salesforce to list or describe metadata types, list or describe all SObjects, make queries, create SFDX Project, validate, deploy or retrieve in SFDX and Metadata API Formats, export and import data and much more. Is used to Aura Helper and Aura Helper CLI to support salesfore conections.
Class to connect with Salesforce to list or describe metadata types, list or describe all SObjects, make queries, create SFDX Project, validate, deploy or retrieve in SFDX and Metadata API Formats, export and import data and much more. Is used to Aura Helper and Aura Helper CLI to support salesfore conections.
The setters methods are defined like a builder pattern to make it more usefull
All connection methods return a Promise with the associated data to the processes.
The fields that start with _ are for internal use only (Does not modify this fields to a correct connection work). To the rest of fields, setter methods are recommended instead modify fields.
Username or Alias to connect with the org. The org bust be authorized in the system.
stringNumber API Version to connect with the org.
string | numberPath to the local project folder
stringNamespace prefix from the Org to connect
stringTrue to able to the connection object to use several threads and processor cores to run some processes and run faster, false to use only one thread and core.
booleanProject package folder path (manifest folder). Must be a child of Project folder
stringProject package file path (package.xml file). Must be a child of Package folder
stringThe Connection class has only one constructor to create a connection
Constructor to create a new connection object. All parameters are optional and you can use the setters methods to set the values when you want.
stringstring | numberstringstringsetUsernameOrAlias(usernameOrAlias)
Method to set the Username or Alias to connect with org
Method to set the API Version to connect
setProjectFolder(projectFolder)
Method to set the project root folder path. When set the project root, automatically set the packageFolder and packageFile to their respective paths
setPackageFolder(packageFolder)
Method to set the package folder path. When set the package folder, automatically set packageFile to the respective path
Method to set the package xml file path
setNamespacePrefix(namespacePrefix)
Method to set the Org namespace prefix
Method to able to the connection object to use several threads and processor cores to run some processes and run faster
Method to set the connection object to use only one thread and processo core to all processes
Method to handle the event when preparing execution of some processes
Method to handle the event before the create a project on some processes
Method to handle the event before start retrieve data on some processes
Method to handle the event before start processing results on some processes
Method to handle the event before start loading local metadata types on some processes
Method to handle the event before start loading metadata types from org on some processes
Method to handle the event before start copying files on some processes
Method to handle the event before start copying file content on some processes
Method to handle the event before start compress XML File on some processes
onBeforeDownloadType(callback)
Method to handle the event before download a Metadata Type from Org on some processes
Method to handle the event after download a Metadata Type from Org on some processes
onBeforeDownloadSObject(callback)
Method to handle the event before download a SObject when describe SObejcts
onAfterDownloadSObject(callback)
Method to handle the event after download a SObject when describe SObejcts
onAfterDownloadSObject(callback)
Method to handle the event after download a SObject when describe SObejcts
Method to handle the event when connection is aborted
Method to abort all connection running processes. When finishes call onAbort() callback
getAuthUsername(usernameOrAlias)
Method to get the username from an authorized org using a username or alias, or using connection username or alias, or using project auth org username or alias
getServerInstance(usernameOrAlias)
Method to get the server instance using a username or alias, or using connection username or alias, or using project auth org username or alias
Method to get the auth org data using a username or alias, or using connection username or alias, or using project auth org username or alias
Method to list all auth org on the system
Method to execute a query to the connected org
Method to list all Metadata Types available in the connected org (according selected API Version)
describeMetadataTypes(typesOrDetails, downloadAll)
Method to describe all or selected Metadata Types from the connected org
Method to list all SObjects API Name by category
Method to describe SObject data to the specified objects
retrieve(useMetadataAPI, waitMinutes, targetDir)
Method to retrieve data using the connection package file. You can choose to retrieve as Metadata API format or Source Format
retrieveReport(retrieveId, targetDir)
Retrieve report when use Metadata API to retrieve data
validateDeploy(testLevel, runTests, useMetadataAPI, waitMinutes)
Method to validate a deploy against the org using the connection package file
deployPackage(testLevel, runTests, useMetadataAPI, waitMinutes)
Method to deploy data to the org using the connection package file
deploy(types, testLevel, runTests, waitMinutes)
Method to deploy the selected Metadata Types to the org using Source API
quickDeploy(deployId, useMetadataAPI)
Method to execute a quick deploy when validation result is success
deployReport(deployId, useMetadataAPI, waitMinutes)
Method to get the report of a running deployment
cancelDeploy(deployId, useMetadataAPI, waitMinutes)
Method to get the cancel a running deployment
convertProjectToSFDX(targetDir)
Method to convert a Metadata API format Project to a Source format
convertProjectToMetadataAPI(targetDir)
Method to convert a Source format Project to a Metadata API format
createSFDXProject(projectName, projectFolder, template, withManifest)
Method to create a SFDX Project. This method change the connection object project folder, package folder and package file values when project is created
Method to set an auth org in a Salesforce local project. This command set the selected username or Alias to the connection object when authorize an org.
exportTreeData(query, outputPath, prefix)
Method to export data in a tree format from the connected org
Method to import data in a tree format into the connected org
Method to delete data on bulk mode
executeApexAnonymous(scriptfile)
Method to execute an Apex script file on Anonymous context
loadUserPermissions(tmpFolder)
Method to get all available user permissions from the connected org
retrieveLocalSpecialTypes(tmpFolder, types, compress, sortOrder)
Method to Retrieve local special types from the connected org
retrieveMixedSpecialTypes(tmpFolder, types, downloadAll, compress, sortOrder)
Method to Retrieve mixed special types from the connected org. Mixed means that only affect the Metadata Types on your project folder, but download all related data from this types from your org (and not only the local data)
retrieveOrgSpecialTypes(tmpFolder, types, downloadAll, compress, sortOrder)
Method to Retrieve org special types from the connected org. Org means that affect all Metadata types stored in your org not on your local project.
Method to set the Username or Alias to connect with org
stringReturns the connection object
ConnectionSet Connection username or alias
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setUsernameOrAlias('MyOrg');
Method to set the API Version to connect
string | numberReturns the connection object
ConnectionSet Connection api version
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setApiVersion(50);
// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setApiVersion(50);
Method to set the project root folder path. When set the project root, automatically set the packageFolder and packageFile to their respective paths
stringReturns the connection object
ConnectionSet Connection project folder
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setProjectFolder('project/root/path');
// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setProjectFolder('project/root/path');
Method to set the package folder path. When set the package folder, automatically set packageFile to the respective path
stringReturns the connection object
ConnectionSet Connection package folder (manifest folder)
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setPackageFolder('project/root/path/manifest');
// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setPackageFolder('project/root/path/manifest');
Method to set the package xml file path
stringReturns the connection object
ConnectionSet Connection package file (package.xml)
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setPackageFile('project/root/path/manifest/package.xml');
// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setPackageFile('project/root/path/manifest/package.xml');
Method to set the package xml file path
stringReturns the connection object
ConnectionSet Connection namespace prefix
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setNamespacePrefix('orgPrefix');
// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setNamespacePrefix('orgPrefix');
Method to able to the connection object to use several threads and processor cores to run some processes and run faster
Returns the connection object
ConnectionSet Connection to user multiple threads and cores
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setMultiThread();
// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setMultiThread();
Method to set the connection object to use only one thread and processo core to all processes
Returns the connection object
ConnectionSet Connection to user single thread and core
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setSingleThread();
// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setSingleThread();
Method to handle the event when preparing execution of some processes
FunctionReturns the connection object
ConnectionHandling progress on prepare stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onPrepare(() => {
console.log('Handling progress on prepare');
}));
Method to handle the event before the create a project on some processes
FunctionReturns the connection object
ConnectionHandling progress on create project stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onCreateProject(() => {
console.log('Handling progress on create project');
}));
Method to handle the event before start retrieve data on some processes
FunctionReturns the connection object
ConnectionHandling progress on retrieve stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onRetrieve(() => {
console.log('Handling progress on create project');
}));
Method to handle the event before start processing results on some processes
FunctionReturns the connection object
ConnectionHandling progress on process stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onProcess(() => {
console.log('Handling progress when process');
}));
Method to handle the event before start loading local metadata types on some processes
FunctionReturns the connection object
ConnectionHandling progress on loading local stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onLoadingLocal(() => {
console.log('Handling progress on loading local data');
}));
Method to handle the event before start loading metadata types from org on some processes
FunctionReturns the connection object
ConnectionHandling progress on loading org stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onLoadingOrg(() => {
console.log('Handling progress on create project');
}));
Method to handle the event before start copying files on some processes
FunctionReturns the connection object
ConnectionHandling progress on copy data stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onCopyData(() => {
console.log('Handling progress when copy data');
}));
Method to handle the event before start copying file content on some processes
FunctionReturns the connection object
ConnectionHandling progress on copy file stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onCopyFile((status) => {
console.log('Handling progress when copy file');
console.log('MetadataType => ' + status.entityType);
console.log('MetadataObject => ' + status.entityObject);
console.log('MetadataItem => ' + status.entityItem);
console.log('file => ' + status.data);
}));
Method to handle the event before start compress XML File on some processes
FunctionReturns the connection object
ConnectionHandling progress on compress file stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onCompressFile((status) => {
console.log('Handling progress when compress file');
console.log('MetadataType => ' + status.entityType);
console.log('MetadataObject => ' + status.entityObject);
console.log('MetadataItem => ' + status.entityItem);
console.log('file => ' + status.data);
}));
Method to handle the event before download a Metadata Type from Org on some processes
FunctionReturns the connection object
ConnectionHandling progress on before download type stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onBeforeDownloadType((status) => {
console.log('Handling progress when describe metadata types');
console.log('MetadataType => ' + status.entityType);
}));
Method to handle the event after download a Metadata Type from Org on some processes
FunctionReturns the connection object
ConnectionHandling progress on after download type stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onAfterDownloadType((status) => {
console.log('Handling progress when describe metadata types');
console.log('MetadataType => ' + status.entityType);
console.log('Downloaded Data => ' + status.data);
}));
Method to handle the event before download a SObject when describe SObejcts
FunctionReturns the connection object
ConnectionHandling progress on before download sobject stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onBeforeDownloadSObject((status) => {
console.log('Handling progress describe sobjects');
console.log('SObject => ' + status.entityObject);
}));
Method to handle the event after download a SObject when describe SObejcts
FunctionReturns the connection object
ConnectionHandling progress on after download sobject stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onAfterDownloadSObject((status) => {
console.log('Handling progress describe sobjects');
console.log('SObject => ' + status.entityObject);
console.log('Downloaded Data => ' + status.data);
}));
Method to handle the event when error ocurred when download metadata
FunctionReturns the connection object
ConnectionHandling progress on error download stage
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onErrorDownload((status) => {
console.log('Handling progress describe sobjects');
console.log('Metadata or SObject => ' + status.entityObject);
console.log('message' + status.data);
}));
Method to handle the event when connection is aborted
FunctionReturns the connection object
ConnectionSet connection abort callback
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onAbort(() => {
}));
// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').onAbort(() => {
}));
Method to abort all connection running processes. When finishes call onAbort() callback
Abort connection and handle on abort callback
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.onAbort(() => {
// Execute when abortConnection() finish and kill all running processes
}));
connection.abortConnection();
Method to get the username from an authorized org using a username or alias, or using connection username or alias, or using project auth org username or alias
stringReturn a String promise with the Username or Alias data
Promise<string>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorGet auth username from the connection project If connection has not username or alias defined and not provide it to the method, get the auth username from the project
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector(undefined, 50, 'path/to/project/root');
connection.getAuthUsername().then((username) => {
console.log(username);
}).catch((error) => {
// Handle errors
});
Get auth username from connection alias If connection has username and not alias provided to the method, get username from connection username or alias
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('OrgAlias', 50, 'path/to/project/root');
connection.getAuthUsername().then((username) => {
console.log(username);
}).catch((error) => {
// Handle errors
});
Get auth username for any alias To get the username for any authorized alias, provide it to the method
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('OrgAlias', 50, 'path/to/project/root');
connection.getAuthUsername('OtherOrgAlias').then((username) => {
console.log(username);
}).catch((error) => {
// Handle errors
});
Method to get the server instance using a username or alias, or using connection username or alias, or using project auth org username or alias
stringReturn a String promise with the instance URL
Promise<string>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorGet server instance to the connected org
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.setUsernameOrAlias('MyOrg');
connection.getServerInstance().then((inbstanceUrl) => {
console.log(inbstanceUrl);
}).catch((error) => {
// Handle errors
});
Get server instance to another
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector();
connection.getServerInstance('MyOrg2').then((inbstanceUrl) => {
console.log(inbstanceUrl);
}).catch((error) => {
// Handle errors
});
Method to get the server instance using a username or alias, or using connection username or alias, or using project auth org username or alias
stringReturn a promise with Auth Org data or undefined if not exists
Promise<AuthOrg | undefined>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorGet auth org from the connection project If connection has not username or alias defined and not provide it to the method, get the auth org data from the project
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector(undefined, 50, 'path/to/project/root');
connection.getAuthOrg().then((authOrg) => {
console.log(authOrg);
}).catch((error) => {
// Handle errors
});
Get auth org from connection alias If connection has username and not alias provided to the method, get auth org data from connection username or alias
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('OrgAlias', 50, 'path/to/project/root');
connection.getAuthOrg().then((authOrg) => {
console.log(authOrg);
}).catch((error) => {
// Handle errors
});
Get auth org for any alias To get the auth org data for any authorized alias, provide it to the method
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('OrgAlias', 50, 'path/to/project/root');
connection.getAuthOrg('OtherOrgAlias').then((authOrg) => {
console.log(authOrg);
}).catch((error) => {
// Handle errors
});
Method to list all auth org on the system
Return a promise with all authorized org in the system
Promise<AuthOrg[]>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorGet all auth org on the system
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 50);
connection.listAuthOrgs().then((authOrgs) => {
for(const org of authOrgs){
console.log('Alias: ' + org.alias);
console.log('Username: ' + org.username);
console.log('ORG Id: ' + org.orgId);
console.log('Instance URL: ' + org.instanceUrl);
console.log('Access Token: ' + org.accessToken);
console.log('OAuth Method: ' + org.oauthMethod);
}
}).catch((error) => {
// Handle errors
});
Method to execute a query to the connected org. Can return a Typed data (or use any to return any json)
stringbooleanReturn a promise with the record list
Promise<T[]>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemQuery data and handle results
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 50);
const query = 'Select Id, Name, Phone, CustomField__c from Account where Name != null';
interface AccountRecord {
Id: string;
Name: string;
Phone: string;
CustomField__c: string;
}
connection.query<AccountRecord>(query).then((records) => {
// records will be an instance of AccountRecord[];
for(const record of records){
console.log('Account Id: ' + record.Id);
console.log('Account Name: ' + record.Name);
console.log('Account Phone: ' + record.Phone);
console.log('Account Custom Field: ' + record.CustomField__c);
}
}).catch((error) => {
// Handle errors
});
Method to list all Metadata Types available in the connected org (according selected API Version)
Return a promise with the MetadataDetail objects from all available Metadata Types
Promise<MetadataDetail[]>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDatatypeException: If the api version is not a Number or String. Can be undefinedGet all available Metadata types to API 45
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 45);
connection.listMetadataTypes().then((metadataDetails) => {
for(const detail of metadataDetails){
console.log('Directory Name: ' + detail.directoryName);
console.log('In folder: ' + detail.inFolder);
console.log('Has Meta file: ' + detail.metaFile);
console.log('Files suffix: ' + detail.suffix);
console.log('API Name: ' + detail.xmlName);
}
}).catch((error) => {
// Handle errors
});
Get all available Metadata types to API 51
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
connection.listMetadataTypes().then((metadataDetails) => {
for(const detail of metadataDetails){
console.log('Directory Name: ' + detail.directoryName);
console.log('In folder: ' + detail.inFolder);
console.log('Has Meta file: ' + detail.metaFile);
console.log('Files suffix: ' + detail.suffix);
console.log('API Name: ' + detail.xmlName);
}
}).catch((error) => {
// Handle errors
});
Method to describe all or selected Metadata Types from the connected org. See Metadata JSON Format section to understand the JSON Metadata Format
string[] | MetadataDetail[]booleanbooleanReturn a promise with Metadata JSON Object with the selected Metadata Types to describe
Promise<{ [key: string]: MetadataType }>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDatatypeException: If the api version is not a Number or String. Can be undefinedDescribe all Metadata types from the connected org and org namespace
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
connection.describeMetadataTypes().then((metadataTypes) => {
for(const metadataTypeName of Object.keys(metadataTypes)){
const metadataType = metadataTypes[metadataTypeName];
console.log('metadataType: ' + metadataType);
}
}).catch((error) => {
// Handle errors
});
Describe all Metadata types from the connected org and all namespaces
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
connection.describeMetadataTypes(undefined, true).then((metadataTypes) => {
for(const metadataTypeName of Object.keys(metadataTypes)){
const metadataType = metadataTypes[metadataTypeName];
console.log('metadataType: ' + metadataType);
}
}).catch((error) => {
// Handle errors
});
Describe some Metadata types from the connected
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
const types = [
'CustomObject',
'CustomField',
'ApexClass'
];
connection.describeMetadataTypes(types).then((metadataTypes) => {
for(const metadataTypeName of Object.keys(metadataTypes)){
const metadataType = metadataTypes[metadataTypeName];
console.log('metadataType: ' + metadataType);
}
}).catch((error) => {
// Handle errors
});
Method to list all SObjects API Name by category
stringReturn a promise with a list with the sObject names
Promise<string[]>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemList all SObjects
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
connection.listSObjects().then((objectNames) => {
for(const objName of objectNames){
console.log('Name: ' + objName);
}
}).catch((error) => {
// Handle errors
});
List custom SObjects
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
connection.listSObjects('custom').then((objectNames) => {
for(const objName of objectNames){
console.log('Name: ' + objName);
}
}).catch((error) => {
// Handle errors
});
List standard SObjects
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
connection.listSObjects('standard').then((objectNames) => {
for(const objName of objectNames){
console.log('Name: ' + objName);
}
}).catch((error) => {
// Handle errors
});
Method to describe SObject data to the specified objects
string[]Return a promise with a SObjects data
Promise<SObject[]>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemDescribe some SObjects
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
const objects = [
'Account',
'Case',
'Opportunity',
'Task'
];
connection.describeSObjects(objects).then((objectNames) => {
for(const objName of objectNames){
console.log('Name: ' + objName);
}
}).catch((error) => {
// Handle errors
});
Describe all SObjects
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg');
connection.setApiVersion(51);
const allSObjects = await connection.listSObjects();
connection.describeSObjects(allSObjects).then((objectNames) => {
for(const objName of objectNames){
console.log('Name: ' + objName);
}
}).catch((error) => {
// Handle errors
});
Method to retrieve data using the connection package file. You can choose to retrieve as Metadata API format or Source Format
booleanstring | numberstringReturn a promise with the RetrieveResult object with the retrieve result
Promise<RetrieveResult>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder or target dir is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder or target dir not exists or not have access to itInvalidDirectoryPathException: If the project folder or target dir is not a directoryWrongDatatypeException: If the api version is not a Number or String. Can be undefinedRetrieve data using Metadata API Format (With package.xml file on project)
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.retrieve(true, 'path/to/target/dir').then((retrieveResult) => {
console.log(retrieveResult);
}).catch((error) => {
// Handle errors
});
Retrieve data using Source Format (With package.xml file on project)
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.retrieve().then((retrieveResult) => {
console.log(retrieveResult);
}).catch((error) => {
// Handle errors
});
Retrieve report when use Metadata API to retrieve data
stringstringReturn a promise with the RetrieveStatus object with the retrieve status result
Promise<RetrieveStatus>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the target dir is not a String or can't convert to absolute pathDirectoryNotFoundException: If the target dir not exists or not have access to itInvalidDirectoryPathException: If the target dir is not a directoryGet a retrieve report status
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const retrieveId = '';
const targetDir = 'path/to/target/retrieve/dir';
connection.retrieveReport(retrieveId, targetDir).then((retrieveStatus) => {
console.log(retrieveStatus);
}).catch((error) => {
// Handle errors
});
Method to validate a deploy against the org using the connection package file
stringstring | string[]booleanstring | numberReturn a promise with the DeployStatus object with the deploy status result
Promise<DeployStatus>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder or package folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder or package folder not exists or not have access to itInvalidDirectoryPathException: If the project folder or package folder is not a directoryWrongFilePathException: If the package file is not a String or can't convert to absolute pathFileNotFoundException: If the package file not exists or not have access to itInvalidFilePathException: If the package file is not a fileWrongDatatypeException: If the api version is not a Number or String. Can be undefinedValidate deployment with Metadata API format (With package.xml file on project)
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const testLevel = 'RunSpecifiedTests';
const runTest = [
'ApexTest1',
'ApexTest2',
'ApexText3',
...,
...,
'ApexTextN',
];
connection.validateDeploy(testLevel, runTest, true).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Validate deployment with Source format (With package.xml file on project)
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const testLevel = 'RunSpecifiedTests';
const runTest = [
'ApexTest1',
'ApexTest2',
'ApexText3',
...,
...,
'ApexTextN',
];
connection.validateDeploy(testLevel, runTest).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Method to deploy data to the org using the connection package file
stringstring | string[]booleanstring | numberReturn a promise with the DeployStatus object with the deploy status result
Promise<DeployStatus>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder or package folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder or package folder not exists or not have access to itInvalidDirectoryPathException: If the project folder or package folder is not a directoryWrongFilePathException: If the package file is not a String or can't convert to absolute pathFileNotFoundException: If the package file not exists or not have access to itInvalidFilePathException: If the package file is not a fileWrongDatatypeException: If the api version is not a Number or String. Can be undefinedDeploy data with Metadata API format (With package.xml file on project)
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const testLevel = 'RunSpecifiedTests';
const runTest = [
'ApexTest1',
'ApexTest2',
'ApexText3',
...,
...,
'ApexTextN',
];
connection.deployPackage(testLevel, runTest, true).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Deploy data with Source format (With package.xml file on project)
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const testLevel = 'RunSpecifiedTests';
const runTest = [
'ApexTest1',
'ApexTest2',
'ApexText3',
...,
...,
'ApexTextN',
];
connection.deployPackage(testLevel, runTest).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Method to deploy data to the org using the connection package file
string | { [key: string]: MetadataType }stringstring | string[]string | numberReturn a promise with the DeployStatus object with the deploy status result
Promise<DeployStatus>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder or package folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder or package folder not exists or not have access to itInvalidDirectoryPathException: If the project folder or package folder is not a directoryWrongFormatException: If JSON Metadata Object has incorrect formatInvalidFilePathException: If the package file is not a fileWrongDatatypeException: If the api version is not a Number or String. Can be undefinedDeploy data with Source format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const types = 'CustomLabel:LabelName1, Profile:ProfileName1';
const testLevel = 'RunSpecifiedTests';
const runTest = [
'ApexTest1',
'ApexTest2',
'ApexText3',
...,
...,
'ApexTextN',
];
connection.deploy(types, testLevel, runTest).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Method to execute a quick deploy when validation result is success
stringbooleanReturn a promise with the DeployStatus object with the deploy status result
Promise<DeployStatus>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder not exists or not have access to itInvalidDirectoryPathException: If the project folder is not a directoryWrongDatatypeException: If the api version is not a Number or String. Can be undefinedExecute quick deploy to Validated deploy with Metadata API format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const deployId = '00X213as2984';
connection.quickDeploy(deployId, true).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Execute quick deploy to Validated deploy with Source format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const deployId = '00X213as2984';
connection.quickDeploy(deployId).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Method to get the report of a running deployment
stringbooleanstring | numberReturn a promise with the DeployStatus object with the deploy status result
Promise<DeployStatus>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemExecute deploy report to active deploy with Metadata API format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const deployId = '00X213as2984';
connection.deployReport(deployId, true).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Execute deploy report to active deploy with Source format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const deployId = '00X213as2984';
connection.deployReport(deployId).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Method to get the cancel a running deployment
stringbooleanstring | numberReturn a promise with the DeployStatus object with the deploy status result
Promise<DeployStatus>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemCancel deploy to active deploy with Metadata API format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const deployId = '00X213as2984';
connection.cancelDeploy(deployId, true).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Cancel deploy to active deploy with Source format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const deployId = '00X213as2984';
connection.cancelDeploy(deployId).then((deployStatus) => {
console.log(deployStatus);
}).catch((error) => {
// Handle errors
});
Method to convert a Metadata API format Project to a Source format
stringReturn an empty promise when conversion finish
Promise<void>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the package folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the package folder not exists or not have access to itInvalidDirectoryPathException: If the package folder is not a directoryWrongFilePathException: If the package file is not a String or can't convert to absolute pathFileNotFoundException: If the package file not exists or not have access to itInvalidFilePathException: If the package file is not a fileWrongDatatypeException: If the api version is not a Number or String. Can be undefinedConvert Metadata API Format project to Source Format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.convertProjectToSFDX('path/to/folder/to/save/project').then(() => {
// Conversion finished
}).catch((error) => {
// Handle errors
});
Method to convert a Metadata API format Project to a Source format
stringReturn an empty promise when conversion finish
Promise<void>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the package folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the package folder not exists or not have access to itInvalidDirectoryPathException: If the package folder is not a directoryWrongFilePathException: If the package file is not a String or can't convert to absolute pathFileNotFoundException: If the package file not exists or not have access to itInvalidFilePathException: If the package file is not a fileWrongDatatypeException: If the api version is not a Number or String. Can be undefinedConvert Source Format project to Metadata API Format
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.convertProjectToMetadataAPI('path/to/folder/to/save/project').then(() => {
// Conversion finished
}).catch((error) => {
// Handle errors
});
Method to create a SFDX Project. This method change the connection object project folder, package folder and package file values when project is created
stringstringstringbooleanReturn a promise with SFDXProjectResult Object with the creation result
Promise<SFDXProjectResult>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder not exists or not have access to itInvalidDirectoryPathException: If the project folder is not a directoryCreate new SFDX Project with connection project folder
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const projectName = 'NEW SFDX Project';
connection.createSFDXProject(projectName).then((createResult) => {
console.log(createResult);
}).catch((error) => {
// Handle errors
});
Create new SFDX Project on a different connection project folder
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const projectName = 'NEW SFDX Project';
const projectFolder = 'path/to/project/folder';
connection.createSFDXProject(projectName, projectFolder).then((createResult) => {
console.log(createResult);
}).catch((error) => {
// Handle errors
});
Method to set an auth org in a Salesforce local project. This command set the selected username or Alias to the connection object when authorize an org.
stringReturn an empty promise when operation finish
Promise<void>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder not exists or not have access to itInvalidDirectoryPathException: If the project folder is not a directoryAuth new org with connection username or alias
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.setAuthOrg().then(() => {
// Org set
}).catch((error) => {
// Handle errors
});
Auth new org with different connection username or alias
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const usernameOrAlias = 'MyOrg2';
connection.setAuthOrg(usernameOrAlias).then(() => {
// Org set
}).catch((error) => {
// Handle errors
});
Method to export data in a tree format from the connected org
stringstringstringReturn an array with the extrated data information
Promise<ExportTreeDataResult[]>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the output folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the output folder not exists or not have access to itInvalidDirectoryPathException: If the output folder is not a directoryWrongDatatypeException: If the api version is not a Number or String. Can be undefinedExport Accounts data with related contacts
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const query = 'Select Id, Name, Phone, (Select Id, Name, Phone from Contacts) from Account where Name != null';
const outputPath = 'path/to/save/the/result';
connection.exportTreeData(query, outputPath).then((results) => {
for(const result of results){
console.log(result.file);
console.log(result.nRecords);
console.log(result.isPlanFile);
}
}).catch((error) => {
// Handle errors
});
Method to import data in a tree format into the connected org
stringReturn a promise with an object with the ok result and errors on insert
Promise<ImportTreeDataResponse>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongFilePathException: If the file is not a String or can't convert to absolute pathFileNotFoundException: If the file not exists or not have access to itInvalidFilePathException: If the file is not a directoryWrongDatatypeException: If the api version is not a Number or String. Can be undefinedImport file with exported records
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const fileToImport = 'path/to/file/to/import.json';
connection.importTreeData(fileToImport).then((result) => {
if(result.results){
for(const result of result.results){
console.log(result.refId);
console.log(result.id);
console.log(result.sobject);
}
} else {
for(const error of result.errors){
console.log(error);
}
}
}).catch((error) => {
// Handle errors
});
Method to delete data on bulk mode
stringstringReturn a promise with an array with BulkStatus objects with the delete result
Promise<BulkStatus[]>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder not exists or not have access to itInvalidDirectoryPathException: If the project folder is not a directoryWrongFilePathException: If the csv file is not a String or can't convert to absolute pathFileNotFoundException: If the csv file not exists or not have access to itInvalidFilePathException: If the csv file is not a directoryWrongDatatypeException: If the api version is not a Number or String. Can be undefinedDelete data at bulk mode
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const csvFile = 'path/to/csv/file/to/delete.csv';
connection.bulkDelete(csvFile, 'Account').then((deleteResults) => {
for(const result of deleteResults){
console.log(result);
}
}).catch((error) => {
// Handle errors
});
Method to execute an Apex script file on Anonymous context
stringReturn a promise with the execution log as String
Promise<string>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the project folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the project folder not exists or not have access to itInvalidDirectoryPathException: If the project folder is not a directoryWrongFilePathException: If the script file is not a String or can't convert to absolute pathFileNotFoundException: If the script file not exists or not have access to itInvalidFilePathException: If the script file is not a directoryWrongDatatypeException: If the api version is not a Number or String. Can be undefinedExecute an Apex Anonymous script
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const scriptFile = 'path/to/csv/file/to/delete.csv';
connection.executeApexAnonymous(scriptFile).then((executionLog) => {
console.log(executionLog);
}).catch((error) => {
// Handle errors
});
Method to get all available user permissions from the connected org
stringReturn a promise with the list of user permissions
Promise<string[]>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the temp folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the temp folder not exists or not have access to itInvalidDirectoryPathException: If the temp folder is not a directoryWrongDatatypeException: If the api version is not a Number or String. Can be undefinedLoad User permissions from connected org
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.loadUserPermissions('path/to/temporal/folder').then((permissions) => {
console.log(permissions);
}).catch((error) => {
// Handle errors
});
Method to get all available user permissions from the connected org
stringstring | { [key: string]: MetadataType }booleanstringReturn a promise with a RetrieveResult with the retrieve result
Promise<RetrieveResult>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the temp folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the temp folder not exists or not have access to itInvalidDirectoryPathException: If the temp folder is not a directoryWrongFilePathException: If the types file is not a String or can't convert to absolute pathFileNotFoundException: If the types file not exists or not have access to itInvalidFilePathException: If the types file is not a fileWrongFormatException: If types object or file is not a JSON file or not have the correct Metadata JSON formatWrongDatatypeException: If the api version is not a Number or String. Can be undefinedRetrieve all local special Metadata Types from Org
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.retrieveLocalSpecialTypes('path/to/temporal/folder').then((result) => {
console.log(result);
}).catch((error) => {
// Handle errors
});
Retrieve some local special Metadata Types from Org
import { SFConnector } from '@aurahelper/connector';
const { Types, Values } = require('@aurahelper/core');
const MetadataTypes = Values.MetadataTypes;
const MetadataType = Types.MetadataType;
const MetadataObject = Types.MetadataObject;
const MetadataItem = Types.MetadataItem;
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const types: {};
types[MetadataTypes.CUSTOM_APPLICATION] = new MetadataType(MetadataTypes.CUSTOM_APPLICATION, true); // set to true Metadata Type to ignore all custom application
types[MetadataTypes.PERMISSION_SET] = new MetadataType(MetadataTypes.PERMISSION_SET, false); // set to false Metadata Type to ignore some permission sets
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet1', true)); // Set to true to repair PermissionSet1
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet2', true)); // Set to true to repair PermissionSet2
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet3', false)); // Set to false to not repair PermissionSet3
connection.retrieveLocalSpecialTypes('path/to/temporal/folder', types).then((result) => {
console.log(result);
}).catch((error) => {
// Handle errors
});
Method to Retrieve mixed special types from the connected org. Mixed means that only affect the Metadata Types on your project folder, but download all related data from this types from your org (and not only the local data)
stringstring | { [key: string]: MetadataType }booleanbooleanstringReturn a promise with a RetrieveResult with the retrieve result
Promise<RetrieveResult>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the temp folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the temp folder not exists or not have access to itInvalidDirectoryPathException: If the temp folder is not a directoryWrongFilePathException: If the types file is not a String or can't convert to absolute pathFileNotFoundException: If the types file not exists or not have access to itInvalidFilePathException: If the types file is not a fileWrongFormatException: If types object or file is not a JSON file or not have the correct Metadata JSON formatWrongDatatypeException: If the api version is not a Number or String. Can be undefinedRetrieve all mixed special Metadata Types from Org
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.retrieveMixedSpecialTypes('path/to/temporal/folder').then((result) => {
console.log(result);
}).catch((error) => {
// Handle errors
});
Retrieve some mixed special Metadata Types from Org
import { SFConnector } from '@aurahelper/connector';
const { Types, Values } = require('@aurahelper/core');
const MetadataTypes = Values.MetadataTypes;
const MetadataType = Types.MetadataType;
const MetadataObject = Types.MetadataObject;
const MetadataItem = Types.MetadataItem;
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const types: {};
types[MetadataTypes.CUSTOM_APPLICATION] = new MetadataType(MetadataTypes.CUSTOM_APPLICATION, true); // set to true Metadata Type to ignore all custom application
types[MetadataTypes.PERMISSION_SET] = new MetadataType(MetadataTypes.PERMISSION_SET, false); // set to false Metadata Type to ignore some permission sets
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet1', true)); // Set to true to repair PermissionSet1
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet2', true)); // Set to true to repair PermissionSet2
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet3', false)); // Set to false to not repair PermissionSet3
connection.retrieveMixedSpecialTypes('path/to/temporal/folder', types).then((result) => {
console.log(result);
}).catch((error) => {
// Handle errors
});
Method to Retrieve org special types from the connected org. Org means that affect all Metadata types stored in your org not on your local project.
stringstring | { [key: string]: MetadataType }booleanbooleanstringReturn a promise with a RetrieveResult with the retrieve result
Promise<RetrieveResult>This method can throw the next exceptions:
ConnectionException: If run other connection process when has one process running or Connection Return an errorDataRequiredException: If required data is not providedOSNotSupportedException: When run this processes with not supported operative systemWrongDirectoryPathException: If the temp folder is not a String or can't convert to absolute pathDirectoryNotFoundException: If the temp folder not exists or not have access to itInvalidDirectoryPathException: If the temp folder is not a directoryWrongFilePathException: If the types file is not a String or can't convert to absolute pathFileNotFoundException: If the types file not exists or not have access to itInvalidFilePathException: If the types file is not a fileWrongFormatException: If types object or file is not a JSON file or not have the correct Metadata JSON formatWrongDatatypeException: If the api version is not a Number or String. Can be undefinedRetrieve all org special Metadata Types from Org
import { SFConnector } from '@aurahelper/connector';
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
connection.retrieveOrgSpecialTypes('path/to/temporal/folder').then((result) => {
console.log(result);
}).catch((error) => {
// Handle errors
});
Retrieve some org special Metadata Types from Org
import { SFConnector } from '@aurahelper/connector';
const { Types, Values } = require('@aurahelper/core');
const MetadataTypes = Values.MetadataTypes;
const MetadataType = Types.MetadataType;
const MetadataObject = Types.MetadataObject;
const MetadataItem = Types.MetadataItem;
const connection = new SFConnector('MyOrg', 51, 'path/to/project/folder');
const types: {};
types[MetadataTypes.CUSTOM_APPLICATION] = new MetadataType(MetadataTypes.CUSTOM_APPLICATION, true); // set to true Metadata Type to ignore all custom application
types[MetadataTypes.PERMISSION_SET] = new MetadataType(MetadataTypes.PERMISSION_SET, false); // set to false Metadata Type to ignore some permission sets
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet1', true)); // Set to true to repair PermissionSet1
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet2', true)); // Set to true to repair PermissionSet2
types[MetadataTypes.PERMISSION_SET].addChild(new MetadataObject('PermissionSet3', false)); // Set to false to not repair PermissionSet3
connection.retrieveOrgSpecialTypes('path/to/temporal/folder', types).then((result) => {
console.log(result);
}).catch((error) => {
// Handle errors
});
The Metadata JSON Format used by Aura Helper Framework and modules have the next structure. Some fields are required and the datatypes checked to ensure the correct file structure.
{
"MetadataAPIName": {
"name": "MetadataAPIName", // Required (String). Contains the Metadata Type API Name (like object Key)
"checked": false, // Required (Boolean). Field for include this type on package or not
"path": "path/to/the/metadata/folder", // Optional (String). Path to the Metadata Type folder in local project
"suffix": "fileSuffix", // Optional (String). Metadata File suffix
"childs": { // Object with a collection of childs (Field required (JSON Object) but can be an empty object)
"MetadataObjectName":{
"name": "MetadataObjectName", // Required (String). Contains the Metadata Object API Name (like object Key)
"checked": false, // Required (Boolean). Field for include this object on package or not
"path": "path/to/the/metadata/file/or/folder", // Optional (String). Path to the object file or folder path
"childs": { // Object with a collection of childs (Field required (JSON Object) but can be an empty object)
"MetadataItemName": {
"name": "MetadataItemName", // Required (String). Contains the Metadata Item API Name (like object Key)
"checked": false, // Required (Boolean). Field for include this object on package or not
"path": "path/to/the/metadata/file"
},
"MetadataItemName2": {
...
},
...,
...,
...
}
}
"MetadataObjectName2":{
...
},
...,
...,
...
}
}
}
{
"CustomObject": {
"name": "CustomObject",
"checked": false,
"path": "path/to/root/project/force-app/main/default/objects",
"suffix": "object",
"childs": {
"Account": {
"name": "Account",
"checked": true, // Add Account Object to the package
"path": "path/to/root/project/force-app/main/default/objects/Account/Account.object-meta.xml",
"childs": {}
},
"Case": {
"name": "Case",
"checked": true, // Add Case Object to the package
"path": "path/to/root/project/force-app/main/default/objects/Case/Case.object-meta.xml",
"childs": {}
},
...,
...,
...
}
},
"CustomField": {
"name": "CustomField",
"checked": false,
"path": "path/to/root/project/force-app/main/default/objects",
"suffix": "field",
"childs": {
"Account": {
"name": "Account",
"checked": false,
"path": "path/to/root/project/force-app/main/default/objects/Account/fields",
"childs": {
"customField__c": {
"name": "customField__c",
"checked": true, // Add customField__c to the package
"path": "path/to/root/project/force-app/main/default/objects/Account/fields/customField__c.field-meta.xml",
},
...,
...,
...
}
},
"Case": {
"name": "Case",
"checked": false,
"path": "path/to/root/project/force-app/main/default/objects/Case/fields",
"childs": {
"CaseNumber": {
"name": "CaseNumber",
"checked": true, // Add CaseNumber to the package
"path": "path/to/root/project/force-app/main/default/objects/Account/fields/CaseNumber.field-meta.xml",
},
...,
...,
...
}
},
...,
...,
...
}
}
}
[2.3.0 - 2023-12-07]
FAQs
Powerfull Libraries to connect with Salesforce to list, describe, deploy or retrieve metadata types. Also can describe SObjects, Create Projects, Authorize Orgs, Execute Queries, Export or Import Data... To the correct work of this library, you need to ha
We found that @aurahelper/connector demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.