@purelightpower/jsforce v1.0.1

JSForce

Purelight Power's fork of Shinichi Tomita's jsforce. JSForce is a Salesforce API Library for JavaScript applications (both on web browser and Node.js).

Overview

JSforce (f.k.a. Node-Salesforce) is an isomorphic JavaScript Library utilizing Salesforce's API: It works both in the browser and with Node.js.

It capsulates the access to various APIs provided by Salesforce in asynchronous JavaScript function calls.

It also has command line interface (CLI) which gives interactive console (REPL), so you can learn the usage without hassle.

Supported Salesforce APIs are the following:

• REST API (SOQL, SOSL, describe, etc.)
• Apex REST
• Analytics API
• Bulk API
• Chatter API
• Metadata API
• SOAP API
• Streaming API
• Tooling API

Documentation

See documentation in http://jsforce.github.io/ .

Releases

See Releases.

License

See license (MIT License).

Authors

• Shinichi Tomita shinichi.tomita@gmail.com

Contributors

• Morgan Billingsley mbillingsley@purelightpower.com

Notes

This is a fork of Shinichi Tomita's original repository. We made some enhancements for using the library in the browser.

Tests

NodeJS Tests

In order to run tests you will need a Salesforce Developer Org

You will also need to install the JsforceTestSuite package, which can be done by running:

SF_USERNAME=myusername SF_PASSWORD=password+securityToken ./test/bin/org-setup

You may need to run this more then once if you encounter timeouts or dropped connections/

Finally, to run the tests simply do:

SF_USERNAME=myusername SF_PASSWORD=password+securityToken npm run test:node

Browser Tests

To run the browser tests, you need to do the following:

1. Create a .env file.
2. Add a variable in the .env file called SALESFORCE_CONSUMER_KEY=. It should be set the the value of your Connected Salesforce App's consumer key.
3. Once you've done the previous two steps, you can run the following command:

npm run test:browser

This will give you a list of tests that can be run, select one and a new tab should be opened in your machine's default browser for the test that you selected.

Contributions

Your contributions are welcome: both by reporting issues on GitHub issues or pull-requesting patches.

If you want to implement any additional features, to be added to JSforce to our master branch, which may or may not be merged please first check current opening issues with milestones and confirm whether the feature is on road map or not.

If your feature implementation is brand-new or fixing unsupposed bugs in the library's test cases, please include addtional test codes in the test/ directory.