New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@aurahelper/connector

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@aurahelper/connector

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

  • 1.1.1
  • Source
  • npm
  • Socket score
Version published
Weekly downloads
49
decreased by-35.53%
Maintainers
1
Weekly downloads
 
Created
Source

Aura Helper Connector Module

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.

Table of Contents

  • Connection Class

  • Metadata JSON Format

Connection Class

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.

Class Members

Fields

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.

usernameOrAlias

Username or Alias to connect with the org. The org bust be authorized in the system.

  • String

apiVersion

Number API Version to connect with the org.

  • String | Number

projectFolder

Path to the local project folder

  • String

namespacePrefix

Namespace prefix from the Org to connect

  • String

multiThread

True 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.

  • Boolean

packageFolder

Project package folder path (manifest folder). Must be a child of Project folder

  • String

packageFile

Project package file path (package.xml file). Must be a child of Package folder

  • String

Constructors

The Connection class has only one constructor to create a connection

constructor(usernameOrAlias, apiVersion, projectFolder, namespacePrefix)

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.

Parameters:

  • usernameOrAlias: Org Username or Alias to connect. (Must be authorized in the system)
    • String
  • apiVersion: API Version number to connect with salesforce
    • String | Number
  • projectFolder: Path to the project root folder
    • String
  • namespacePrefix: Namespace prefix from the Org to connect
    • String

Methods

setUsernameOrAlias(usernameOrAlias)

Method to set the Username or Alias to connect with org

Parameters:

  • usernameOrAlias: Org Username or Alias to connect. (Must be authorized in the system)
    • String

Return:

Returns the connection object

  • Connection

Examples:

Set Connection username or alias

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.setUsernameOrAlias('MyOrg');

setApiVersion(apiVersion)

Method to set the API Version to connect

Parameters:

  • apiVersion: API Version number to connect with salesforce
    • String | Number

Return:

Returns the connection object

  • Connection

Examples:

Set Connection api version

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.setApiVersion(50);

// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setApiVersion(50);

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

Parameters:

  • projectFolder: Path to the project root folder
    • String

Return:

Returns the connection object

  • Connection

Examples:

Set Connection project folder

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.setProjectFolder('project/root/path');

// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setProjectFolder('project/root/path');

setPackageFolder(packageFolder)

Method to set the package folder path. When set the package folder, automatically set packageFile to the respective path

Parameters:

  • packageFolder: Path to the package folder
    • String

Return:

Returns the connection object

  • Connection

Examples:

Set Connection package folder (manifest folder)

const Connection = require('@aurahelper/connector');

const connection = new Connection();

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');

setPackageFile(packageFile)

Method to set the package xml file path

Parameters:

  • packageFile: Path to the package folder
    • String

Return:

Returns the connection object

  • Connection

Examples:

Set Connection package file (package.xml)

const Connection = require('@aurahelper/connector');

const connection = new Connection();

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');

setNamespacePrefix(namespacePrefix)

Method to set the package xml file path

Parameters:

  • namespacePrefix: Namespace prefix from the Org to connect
    • String

Return:

Returns the connection object

  • Connection

Examples:

Set Connection namespace prefix const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.setNamespacePrefix('orgPrefix');

// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setNamespacePrefix('orgPrefix');

setMultiThread()

Method to able to the connection object to use several threads and processor cores to run some processes and run faster

Return:

Returns the connection object

  • Connection

Examples:

Set Connection to user multiple threads and cores

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.setMultiThread();

// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setMultiThread();

setSingleThread()

Method to set the connection object to use only one thread and processo core to all processes

Return:

Returns the connection object

  • Connection

Examples:

Set Connection to user single thread and core

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.setSingleThread();

// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').setSingleThread();

onPrepare(callback)

Method to handle the event when preparing execution of some processes

Parameters:

  • callback: Callback function to call when connection is on prepare
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on prepare stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onPrepare(() => {
  console.log('Handling progress on prepare');
}));

onCreateProject(callback)

Method to handle the event before the create a project on some processes

Parameters:

  • callback: Callback function to handle progress when connection will create a project
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on create project stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onCreateProject(() => {
  console.log('Handling progress on create project');
}));

onRetrieve(callback)

Method to handle the event before start retrieve data on some processes

Parameters:

  • callback: Callback function to handle progress when connection retrieve data
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on retrieve stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onRetrieve(() => {
  console.log('Handling progress on create project');
}));

onProcess(callback)

Method to handle the event before start processing results on some processes

Parameters:

  • callback: Callback function to handle progress when connection is processing results
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on process stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onProcess(() => {
  console.log('Handling progress when process');
}));

onLoadingLocal(callback)

Method to handle the event before start loading local metadata types on some processes

Parameters:

  • callback: Callback function to handle progress when connection load metadata types from local project
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on loading local stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onLoadingLocal(() => {
  console.log('Handling progress on loading local data');
}));

onLoadingOrg(callback)

Method to handle the event before start loading metadata types from org on some processes

Parameters:

  • callback: Callback function to handle progress when connection load metadata types from connected org
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on loading org stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onLoadingOrg(() => {
  console.log('Handling progress on create project');
}));

onCopyData(callback)

Method to handle the event before start copying files on some processes

Parameters:

  • callback: Callback function to handle progress when connection start to copying files
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on copy data stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onCopyData(() => {
  console.log('Handling progress when copy data');
}));

onCopyFile(callback)

Method to handle the event before start copying file content on some processes

Parameters:

  • callback: Callback function to handle progress when connection star to copy a single file
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on copy file stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

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);
}));

onCompressFile(callback)

Method to handle the event before start compress XML File on some processes

Parameters:

  • callback: Callback function to handle progress when start compress
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on compress file stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

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);
}));

onBeforeDownloadType(callback)

Method to handle the event before download a Metadata Type from Org on some processes

Parameters:

  • callback: Callback function to handle progress when start download metadata type
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on before download type stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onBeforeDownloadType((status) => {
  console.log('Handling progress when describe metadata types');
  console.log('MetadataType => ' + status.entityType);
}));

onAfterDownloadType(callback)

Method to handle the event after download a Metadata Type from Org on some processes

Parameters:

  • callback: Callback function to handle progress when metadata type is downloaded
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on after download type stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onAfterDownloadType((status) => {
  console.log('Handling progress when describe metadata types');
  console.log('MetadataType => ' + status.entityType);
  console.log('Downloaded Data => ' + status.data);
}));

onBeforeDownloadSObject(callback)

Method to handle the event before download a SObject when describe SObejcts

Parameters:

  • callback: Callback function to handle progress when start download sobject
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on before download sobject stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onBeforeDownloadSObject((status) => {
  console.log('Handling progress describe sobjects');
  console.log('SObject => ' + status.entityObject);
}));

onAfterDownloadSObject(callback)

Method to handle the event after download a SObject when describe SObejcts

Parameters:

  • callback: Callback function to handle progress when sobject is downloaded
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on after download sobject stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onAfterDownloadSObject((status) => {
  console.log('Handling progress describe sobjects');
  console.log('SObject => ' + status.entityObject);
  console.log('Downloaded Data => ' + status.data);
}));

onErrorDownload(callback)

Method to handle the event when error ocurred when download metadata

Parameters:

  • callback: Callback function to handle error
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Handling progress on error download stage

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onErrorDownload((status) => {
  console.log('Handling progress describe sobjects');
  console.log('Metadata or SObject => ' + status.entityObject);
  console.log('message' + status.data);
}));

onAbort(callback)

Method to handle the event when connection is aborted

Parameters:

  • callback: Callback function to call when connectin is aborted
    • Function

Return:

Returns the connection object

  • Connection

Examples:

Set connection abort callback

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onAbort(() => {

}));

// Or can concatenate method calls because setters return a connection object
connection.setUsernameOrAlias('MyOrg').onAbort(() => {

}));

abortConnection()

Method to abort all connection running processes. When finishes call onAbort() callback

Examples:

Abort connection and handle on abort callback

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.onAbort(() => {
    // Execute when abortConnection() finish and kill all running processes
}));

connection.abortConnection();

getAuthUsername()

Method to get the Auth Username from the org (If not found username, return the Alias)

Return:

Return a String promise with the Username or Alias data

  • Promise<String>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error

Examples:

Get auth username to the connection

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.getAuthUsername().then((username) => {
    console.log(username);
}).catch((error) => {
    // Handle errors
});

getServerInstance(usernameOrAlias)

Method to get the server instance for an username or alias (or the connection username or alias)

Parameters:

  • usernameOrAlias: Username or alias to check. (If not provided, use usernameOrAlias from connection object)
    • String

Return:

Return a String promise with the instance URL

  • Promise<String>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error

Examples:

Get server instance to the connected org

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.setUsernameOrAlias('MyOrg');

connection.getServerInstance().then((inbstanceUrl) => {
    console.log(inbstanceUrl);
}).catch((error) => {
    // Handle errors
});

Get server instance to another

const Connection = require('@aurahelper/connector');

const connection = new Connection();

connection.getServerInstance('MyOrg2').then((inbstanceUrl) => {
    console.log(inbstanceUrl);
}).catch((error) => {
    // Handle errors
});

listAuthOrgs()

Method to list all auth org on the system

Return:

Return a promise with all authorized org in the system

  • Promise<Array<AuthOrg>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error

Examples:

Get all auth org on the system

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

query(query, userToolingApi)

Method to execute a query to the connected org

Parameters:

  • query: Query to execute (Required)
    • String
  • useToolingApi: true to use Tooling API to execute the query
    • Boolean

Return:

Return a promise with the record list

  • Promise<Array<Object>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system

Examples:

Query data and handle results

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 50);

const query = 'Select Id, Name, Phone, CustomField__c from Account where Name != null';

connection.query(query).then((records) => {
    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
});

listMetadataTypes()

Method to list all Metadata Types available in the connected org (according selected API Version)

Return:

Return a promise with the MetadataDetail objects from all available Metadata Types

  • Promise<Array<MetadataDetail>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Get all available Metadata types to API 45

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

describeMetadataTypes(typesOrDetails, downloadAll, groupGlobalActions)

Method to describe all or selected Metadata Types from the connected org. See Metadata JSON Format section to understand the JSON Metadata Format

Parameters:

  • typesOrDetails: List of Metadata Type API Names or Metadata Details to describe (undefined to describe all metadata types)
    • Arra<String> | Array<MetadataDetail>
  • downloadAll: true to download all Metadata Types from the connected org, false to download only the org namespace Metadata Types
    • Boolean
  • groupGlobalActions: True to group global quick actions on "GlobalActions" group, false to include as object and item
    • Boolean

Return:

Return a promise with Metadata JSON Object with the selected Metadata Types to describe

  • Promise<Array<Object>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Describe all Metadata types from the connected org and org namespace

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

listSObjects(category)

Method to list all SObjects API Name by category

Parameters:

  • category: Object Category. Values are: Standard, Custom, All. (All by default)
    • String

Return:

Return a promise with a list with the sObject names

  • Promise<Array<String>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system

Examples:

List all SObjects

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg');
connection.setApiVersion(51);

connection.listSObjects().then((objectNames) => {
    for(const objName of objectNames){
        console.log('Name: ' + objName);
    }
}).catch((error) => {
    // Handle errors
});

List custom SObjects

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg');
connection.setApiVersion(51);

connection.listSObjects('standard').then((objectNames) => {
    for(const objName of objectNames){
        console.log('Name: ' + objName);
    }
}).catch((error) => {
    // Handle errors
});

describeSObjects(sObjects)

Method to describe SObject data to the specified objects

Parameters:

  • sObjects: List with the object API Names to describe
    • Array<String>

Return:

Return a promise with a SObjects data

  • Promise<Array<SObject>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system

Examples:

Describe some SObjects

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

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

Parameters:

  • useMetadataAPI: True to use Metadata API format, false to use source format
    • Boolean
  • waitMinutes: Number of minutes to wait for the command to complete and display results
    • String | Number
  • targetDir: Path to the target dir when retrieve with Metadata API Format
    • String

Return:

Return a promise with the RetrieveResult object with the retrieve result

  • Promise<RetrieveResult>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder or target dir is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder or target dir not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder or target dir is not a directory
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Retrieve data using Metadata API Format (With package.xml file on project)

const Connection = require('@aurahelper/connector');

const connection = new Connection('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)

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

connection.retrieve().then((retrieveResult) => {
    console.log(retrieveResult);
}).catch((error) => {
    // Handle errors
});

retrieveReport(retrieveId, targetDir)

Retrieve report when use Metadata API to retrieve data

Parameters:

  • retrieveId: Retrieve Id to get the report (Required)
    • String
  • targetDir: Path to the target dir (Required)
    • String

Return:

Return a promise with the RetrieveStatus object with the retrieve status result

  • Promise<RetrieveStatus>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the target dir is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the target dir not exists or not have access to it
  • InvalidDirectoryPathException: If the target dir is not a directory

Examples:

Get a retrieve report status

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

validateDeploy(testLevel, runTests, useMetadataAPI, waitMinutes)

Method to validate a deploy against the org using the connection package file

Parameters:

  • testLevel: Level of deployment tests to run. Values are 'NoTestRun', 'RunSpecifiedTests', 'RunLocalTests', 'RunAllTestsInOrg'
    • String
  • runTests: String with comma separated test names to execute or list with the test names to execute
    • String | Array<String>
  • useMetadataAPI: True to validate deploy using Metadata API Format, false to use Source Format
    • Boolean
  • waitMinutes: Number of minutes to wait for the command to complete and display results
    • String | Number

Return:

Return a promise with the DeployStatus object with the deploy status result

  • Promise<DeployStatus>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder or package folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder or package folder not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder or package folder is not a directory
  • WrongFilePathException: If the package file is not a String or can't convert to absolute path
  • FileNotFoundException: If the package file not exists or not have access to it
  • InvalidFilePathException: If the package file is not a file
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Validate deployment with Metadata API format (With package.xml file on project)

const Connection = require('@aurahelper/connector');

const connection = new Connection('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)

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

deployPackage(testLevel, runTests, useMetadataAPI, waitMinutes)

Method to deploy data to the org using the connection package file

Parameters:

  • testLevel: Level of deployment tests to run. Values are 'NoTestRun', 'RunSpecifiedTests', 'RunLocalTests', 'RunAllTestsInOrg'
    • String
  • runTests: String with comma separated test names to execute or list with the test names to execute
    • String | Array<String>
  • useMetadataAPI: True to validate deploy using Metadata API Format, false to use Source Format
    • Boolean
  • waitMinutes: Number of minutes to wait for the command to complete and display results
    • String | Number

Return:

Return a promise with the DeployStatus object with the deploy status result

  • Promise<DeployStatus>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder or package folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder or package folder not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder or package folder is not a directory
  • WrongFilePathException: If the package file is not a String or can't convert to absolute path
  • FileNotFoundException: If the package file not exists or not have access to it
  • InvalidFilePathException: If the package file is not a file
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Deploy data with Metadata API format (With package.xml file on project)

const Connection = require('@aurahelper/connector');

const connection = new Connection('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)

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

deployPackage(testLevel, runTests, useMetadataAPI, waitMinutes)

Method to deploy data to the org using the connection package file

Parameters:

  • types: Metadata JSON Object with the selected elements to deploy or comma separated values String with the metadata types to deploy
    • String | Object
  • testLevel: Level of deployment tests to run. Values are 'NoTestRun', 'RunSpecifiedTests', 'RunLocalTests', 'RunAllTestsInOrg'
    • String
  • runTests: String with comma separated test names to execute or list with the test names to execute
    • String | Array<String>
  • waitMinutes: Number of minutes to wait for the command to complete and display results
    • String | Number

Return:

Return a promise with the DeployStatus object with the deploy status result

  • Promise<DeployStatus>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder or package folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder or package folder not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder or package folder is not a directory
  • WrongFormatException: If JSON Metadata Object has incorrect format
  • InvalidFilePathException: If the package file is not a file
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Deploy data with Source format

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

quickDeploy(deployId, useMetadataAPI)

Method to execute a quick deploy when validation result is success

Parameters:

  • deployId: Id to deploy the validated deployment (Required)
    • String
  • useMetadataAPI: True to execute quick deploy using Metadata API Format, false to use Source Format
    • Boolean

Return:

Return a promise with the DeployStatus object with the deploy status result

  • Promise<DeployStatus>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder is not a directory
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Execute quick deploy to Validated deploy with Metadata API format

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

const deployId = '00X213as2984';

connection.quickDeploy(deployId).then((deployStatus) => {
    console.log(deployStatus);
}).catch((error) => {
    // Handle errors
});

deployReport(deployId, useMetadataAPI, waitMinutes)

Method to get the report of a running deployment

Parameters:

  • deployId: Id to the deployment to get the report (Required)
    • String
  • useMetadataAPI: True to execute deploy report using Metadata API Format, false to use Source Format
    • Boolean
  • waitMinutes: Number of minutes to wait for the command to complete and display results
    • String | Number

Return:

Return a promise with the DeployStatus object with the deploy status result

  • Promise<DeployStatus>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system

Examples:

Execute deploy report to active deploy with Metadata API format

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

const deployId = '00X213as2984';

connection.deployReport(deployId).then((deployStatus) => {
    console.log(deployStatus);
}).catch((error) => {
    // Handle errors
});

cancelDeploy(deployId, useMetadataAPI, waitMinutes)

Method to get the cancel a running deployment

Parameters:

  • deployId: Id to the deployment to cancel (Required)
    • String
  • useMetadataAPI: True to execute cancel deploy using Metadata API Format, false to use Source FormatSource Format
    • Boolean
  • waitMinutes: Number of minutes to wait for the command to complete and display results
    • String | Number

Return:

Return a promise with the DeployStatus object with the deploy status result

  • Promise<DeployStatus>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system

Examples:

Cancel deploy to active deploy with Metadata API format

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

const deployId = '00X213as2984';

connection.cancelDeploy(deployId).then((deployStatus) => {
    console.log(deployStatus);
}).catch((error) => {
    // Handle errors
});

convertProjectToSFDX(targetDir)

Method to convert a Metadata API format Project to a Source format

Parameters:

  • targetDir: Path to the target dir to save the converted project (Required)
    • String

Return:

Return an empty promise when conversion finish

  • Promise<Any>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the package folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the package folder not exists or not have access to it
  • InvalidDirectoryPathException: If the package folder is not a directory
  • WrongFilePathException: If the package file is not a String or can't convert to absolute path
  • FileNotFoundException: If the package file not exists or not have access to it
  • InvalidFilePathException: If the package file is not a file
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Convert Metadata API Format project to Source Format

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

connection.convertProjectToSFDX('path/to/folder/to/save/project').then(() => {
    // Conversion finished
}).catch((error) => {
    // Handle errors
});

convertProjectToMetadataAPI(targetDir)

Method to convert a Metadata API format Project to a Source format

Parameters:

  • targetDir: Path to the target dir to save the converted project (Required)
    • String

Return:

Return an empty promise when conversion finish

  • Promise<Any>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the package folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the package folder not exists or not have access to it
  • InvalidDirectoryPathException: If the package folder is not a directory
  • WrongFilePathException: If the package file is not a String or can't convert to absolute path
  • FileNotFoundException: If the package file not exists or not have access to it
  • InvalidFilePathException: If the package file is not a file
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Convert Source Format project to Metadata API Format

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

connection.convertProjectToMetadataAPI('path/to/folder/to/save/project').then(() => {
    // Conversion finished
}).catch((error) => {
    // Handle errors
});

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

Parameters:

  • projectName: Project Name to create (Required)
    • String
  • projectFolder: Path to save the project. If undefined use the connection project folder
    • String
  • template: Template to use to create the project. Empty by default
    • String
  • withManifest: True to create the project with manifest, false in otherwise
    • Boolean

Return:

Return a promise with SFDXProjectResult Object with the creation result

  • Promise<SFDXProjectResult>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder is not a directory

Examples:

Create new SFDX Project with connection project folder

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

setAuthOrg(usernameOrAlias)

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.

Parameters:

  • usernameOrAlias: Username or alias to auth. (Must be authorized in the system). If undefined use the connection username or alias
    • String

Return:

Return an empty promise when operation finish

  • Promise<Any>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder is not a directory

Examples:

Auth new org with connection username or alias

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

connection.setAuthOrg().then(() => {
    // Org set
}).catch((error) => {
    // Handle errors
});

Auth new org with different connection username or alias

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

const usernameOrAlias = 'MyOrg2';

connection.setAuthOrg(usernameOrAlias).then(() => {
    // Org set
}).catch((error) => {
    // Handle errors
});

exportTreeData(query, outputPath, prefix)

Method to export data in a tree format from the connected org

Parameters:

  • query: Query to extract the data (Required)
    • String
  • outputPath: Path to the folder to (Required)
    • String
  • prefix: Prefix to add to the created files
    • String

Return:

Return an array with the extrated data information

  • Promise<Array<Object>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the output folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the output folder not exists or not have access to it
  • InvalidDirectoryPathException: If the output folder is not a directory
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Export Accounts data with related contacts

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

importTreeData(file)

Method to import data in a tree format into the connected org

Parameters:

  • file: Path to the file to import (Required)
    • String

Return:

Return a promise with an object with the ok result and errors on insert

  • Promise<Object>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongFilePathException: If the file is not a String or can't convert to absolute path
  • FileNotFoundException: If the file not exists or not have access to it
  • InvalidFilePathException: If the file is not a directory
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Import file with exported records

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

bulkDelete(csvfile, sObject)

Method to delete data on bulk mode

Parameters:

  • csvfile: Path to the CSV file with the ids to delete (Required)
    • String
  • sObject: Records SObject API Name (Required)
    • String

Return:

Return a promise with an array with BulkStatus objects with the delete result

  • Promise<Array<BulkStatus>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder is not a directory
  • WrongFilePathException: If the csv file is not a String or can't convert to absolute path
  • FileNotFoundException: If the csv file not exists or not have access to it
  • InvalidFilePathException: If the csv file is not a directory
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Delete data at bulk mode

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

executeApexAnonymous(scriptfile)

Method to execute an Apex script file on Anonymous context

Parameters:

  • scriptfile: Path to the script file (Required)
    • String

Return:

Return a promise with the execution log as String

  • Promise<String>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the project folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the project folder not exists or not have access to it
  • InvalidDirectoryPathException: If the project folder is not a directory
  • WrongFilePathException: If the script file is not a String or can't convert to absolute path
  • FileNotFoundException: If the script file not exists or not have access to it
  • InvalidFilePathException: If the script file is not a directory
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Execute an Apex Anonymous script

const Connection = require('@aurahelper/connector');

const connection = new Connection('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
});

loadUserPermissions(tmpFolder)

Method to get all available user permissions from the connected org

Parameters:

  • tmpFolder: Temporal folder to save support files (Required)
    • String

Return:

Return a promise with the list of user permissions

  • Promise<Array<String>>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the temp folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the temp folder not exists or not have access to it
  • InvalidDirectoryPathException: If the temp folder is not a directory
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Load User permissions from connected org

const Connection = require('@aurahelper/connector');

const connection = new Connection('MyOrg', 51, 'path/to/project/folder');

connection.loadUserPermissions('path/to/temporal/folder').then((permissions) => {
    console.log(permissions);
}).catch((error) => {
    // Handle errors
});

retrieveLocalSpecialTypes(tmpFolder, types, compress, sortOrder)

Method to get all available user permissions from the connected org

Parameters:

  • tmpFolder: Temporal folder to save support files (Required)
    • String
  • types: Metadata JSON Object or Metadata JSON File with the specific types to retrieve. Undefined to retrieve all special types
    • Object
  • compress: true to compress affected files, false in otherwise
    • Boolean
  • sortOrder: Compress sort order when compress files
    • String

Return:

Return a promise with a RetrieveResult with the retrieve result

  • Promise<RetrieveResult>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the temp folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the temp folder not exists or not have access to it
  • InvalidDirectoryPathException: If the temp folder is not a directory
  • WrongFilePathException: If the types file is not a String or can't convert to absolute path
  • FileNotFoundException: If the types file not exists or not have access to it
  • InvalidFilePathException: If the types file is not a file
  • WrongFormatException: If types object or file is not a JSON file or not have the correct Metadata JSON format
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Retrieve all local special Metadata Types from Org

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@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 Connection('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
});

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)

Parameters:

  • tmpFolder: Temporal folder to save support files (Required)
    • String
  • types: Metadata JSON Object or Metadata JSON File with the specific types to retrieve. Undefined to retrieve all special types
    • Object
  • downloadAll: true to compress affected files, false in otherwise
    • Boolean
  • compress: true to download all related data from any namespace, false to downlaod only the org namespace data
    • Boolean
  • sortOrder: Compress sort order when compress files
    • String

Return:

Return a promise with a RetrieveResult with the retrieve result

  • Promise<RetrieveResult>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the temp folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the temp folder not exists or not have access to it
  • InvalidDirectoryPathException: If the temp folder is not a directory
  • WrongFilePathException: If the types file is not a String or can't convert to absolute path
  • FileNotFoundException: If the types file not exists or not have access to it
  • InvalidFilePathException: If the types file is not a file
  • WrongFormatException: If types object or file is not a JSON file or not have the correct Metadata JSON format
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Retrieve all mixed special Metadata Types from Org

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@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 Connection('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
});

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.

Parameters:

  • tmpFolder: Temporal folder to save support files (Required)
    • String
  • types: Metadata JSON Object or Metadata JSON File with the specific types to retrieve. Undefined to retrieve all special types
    • Object
  • downloadAll: true to compress affected files, false in otherwise
    • Boolean
  • compress: true to download all related data from any namespace, false to downlaod only the org namespace data
    • Boolean
  • sortOrder: Compress sort order when compress files
    • String

Return:

Return a promise with a RetrieveResult with the retrieve result

  • Promise<RetrieveResult>

Throws:

This method can throw the next exceptions:

  • ConnectionException: If run other connection process when has one process running or Connection Return an error
  • DataRequiredException: If required data is not provided
  • OSNotSupportedException: When run this processes with not supported operative system
  • WrongDirectoryPathException: If the temp folder is not a String or can't convert to absolute path
  • DirectoryNotFoundException: If the temp folder not exists or not have access to it
  • InvalidDirectoryPathException: If the temp folder is not a directory
  • WrongFilePathException: If the types file is not a String or can't convert to absolute path
  • FileNotFoundException: If the types file not exists or not have access to it
  • InvalidFilePathException: If the types file is not a file
  • WrongFormatException: If types object or file is not a JSON file or not have the correct Metadata JSON format
  • WrongDatatypeException: If the api version is not a Number or String. Can be undefined

Examples:

Retrieve all org special Metadata Types from Org

const Connection = require('@aurahelper/connector');

const connection = new Connection('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

const Connection = require('@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 Connection('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
});

Metadata JSON Format

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":{
               ...
            },
            ...,
            ...,
            ...
        }
    }
}

Example:

{
    "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",
                    },
                    ...,
                    ...,
                    ...
                }
            },
            ...,
            ...,
            ...
        }
    }
}

Keywords

FAQs

Package last updated on 17 Nov 2021

Did you know?

Socket

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.

Install

Related posts

Oracle Drags Its Feet in the JavaScript Trademark Dispute

Security News

Oracle Drags Its Feet in the JavaScript Trademark Dispute

Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.

By Sarah Gooding  -  Feb 07, 2025
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc