anonymous-apex

Easily run anonymous Salesforce Apex code with Node.js or on the command line.

anonymous-apex allows you to run Apex code from the command line or as a Node.js module.

We also allow you to template your Apex code with the EJS templating language. http://www.ejs.co

Install

1# Install locally for Node.js module usage.
2npm i anonymous-apex
3
4# Install globally for command line usage.
5npm i -g anonymous-apex

Enjoy

Node Module

You can require anonymous-apex as a node module.

1const apex = 'System.debug(\'<%= some.message %>\');';
2
3// data is optional.
4const data = {
5  some: {
6    message: 'frank woo'
7  }
8};
9
10const options = {
11  username: process.env.ANONYMOUS_APEX_USERNAME,
12  password: process.env.ANONYMOUS_APEX_PASSWORD
13};
14
15require('anonymous-apex').execute(options, apex, data)
16  .then((results) => {
17    console.error('\ndone', results);
18    // Results look as follows. If compiled or success are false, you
19    // won't get here, an error will be thrown, and you will end up in
20    // the catch block below.
21    //
22    // { line: -1,
23    //   column: -1,
24    //   compiled: true,
25    //   success: true,
26    //   compileProblem: null,
27    //   exceptionStackTrace: null,
28    //   exceptionMessage: null }
29  })
30  .catch((error) => {
31    console.error(error);
32    process.exit(13);
33  });

Commmand Line

You can run anonymous-apex from the command line.

1anonymous-apex my-code.apex
2
3# or with template data.
4anonymous-apex my-code.apex template-data.json

Usage: anonymous-apex APEX [TEMPLATE_DATA]

  APEX (required) is the path to a file containing your Apex code
    OR just a string of Apex code.

  TEMPLATE_DATA (optional) is the path to a file containing
    JSON data to apply to your APEX code template.

  We will use the following environment variables.

  ANONYMOUS_APEX_USERNAME
  ANONYMOUS_APEX_PASSWORD

  Password needs to be your Salesforce password with the security
  token appended.

  You can set the NODE_DEBUG environment variable if you want us
  to be chatty (INDLUDING USERNAME and PASSWORD info)!!!

  NODE_DEBUG=ANONYMOUS_APEX anonymous-apex APEX [TEMPLATE_DATA]