Source: api/apex.js

  1. /**
  2.  * @file Manages Salesforce Apex REST endpoint calls
  3.  * @author Shinichi Tomita <shinichi.tomita@gmail.com>
  4.  */
  6. 'use strict';
  8. var jsforce = require('../core');
  10. /**
  11.  * API class for Apex REST endpoint call
  12.  *
  13.  * @class
  14.  * @param {Connection} conn Connection
  15.  */
  16. var Apex = function(conn) {
  17.   this._conn = conn;
  18. };
  20. /**
  21.  * @private
  22.  */
  23. Apex.prototype._baseUrl = function() {
  24.   return this._conn.instanceUrl + "/services/apexrest";
  25. };
  27. /**
  28.  * @private
  29.  */
  30. Apex.prototype._createRequestParams = function(method, path, body, options) {
  31.   var params = {
  32.     method: method,
  33.     url: this._baseUrl() + path
  34.   },
  35.   _headers = {};
  36.   if(options && 'object' === typeof options['headers']){
  37.     _headers = options['headers'];
  38.   }
  39.   if (!/^(GET|DELETE)$/i.test(method)) {
  40.     _headers["Content-Type"] = "application/json";
  41.   }
  42.   params.headers = _headers;
  43.   if (body) {
  44.     params.body = JSON.stringify(body);
  45.   }
  46.   return params;
  47. };
  49. /**
  50.  * Call Apex REST service in GET request
  51.  *
  52.  * @param {String} path - URL path to Apex REST service
  53.  * @param {Object} options - Holds headers and other meta data for the request.
  54.  * @param {Callback.<Object>} [callback] - Callback function
  55.  * @returns {Promise.<Object>}
  56.  */
  57. Apex.prototype.get = function(path, options, callback) {
  58.   if (typeof options === 'function') {
  59.     callback = options;
  60.     options = undefined;
  61.   }
  62.   return this._conn.request(this._createRequestParams('GET', path, undefined, options)).thenCall(callback);
  63. };
  65. /**
  66.  * Call Apex REST service in POST request
  67.  *
  68.  * @param {String} path - URL path to Apex REST service
  69.  * @param {Object} [body] - Request body
  70.  * @param {Object} options - Holds headers and other meta data for the request.
  71.  * @param {Callback.<Object>} [callback] - Callback function
  72.  * @returns {Promise.<Object>}
  73.  */
  74. Apex.prototype.post = function(path, body, options, callback) {
  75.   if (typeof body === 'function') {
  76.     callback = body;
  77.     body = undefined;
  78.     options = undefined;
  79.   }
  80.   if (typeof options === 'function') {
  81.     callback = options;
  82.     options = undefined;
  83.   }
  84.   var params = this._createRequestParams('POST', path, body, options);
  85.   return this._conn.request(params).thenCall(callback);
  86. };
  88. /**
  89.  * Call Apex REST service in PUT request
  90.  *
  91.  * @param {String} path - URL path to Apex REST service
  92.  * @param {Object} [body] - Request body
  93.  * @param {Object} [options] - Holds headers and other meta data for the request.
  94.  * @param {Callback.<Object>} [callback] - Callback function
  95.  * @returns {Promise.<Object>}
  96.  */
  97. Apex.prototype.put = function(path, body, options, callback) {
  98.   if (typeof body === 'function') {
  99.     callback = body;
  100.     body = undefined;
  101.     options = undefined;
  102.   }
  103.   if (typeof options === 'function') {
  104.     callback = options;
  105.     options = undefined;
  106.   }
  107.   var params = this._createRequestParams('PUT', path, body, options);
  108.   return this._conn.request(params).thenCall(callback);
  109. };
  111. /**
  112.  * Call Apex REST service in PATCH request
  113.  *
  114.  * @param {String} path - URL path to Apex REST service
  115.  * @param {Object} [body] - Request body
  116.  * @param {Object} [options] - Holds headers and other meta data for the request.
  117.  * @param {Callback.<Object>} [callback] - Callback function
  118.  * @returns {Promise.<Object>}
  119.  */
  120. Apex.prototype.patch = function(path, body, options, callback) {
  121.   if (typeof body === 'function') {
  122.     callback = body;
  123.     body = undefined;
  124.     options = undefined;
  125.   }
  126.   if (typeof options === 'function') {
  127.     callback = options;
  128.     options = undefined;
  129.   }
  130.   var params = this._createRequestParams('PATCH', path, body, options);
  131.   return this._conn.request(params).thenCall(callback);
  132. };
  134. /**
  135.  * Synonym of Apex#delete()
  136.  *
  137.  * @method Apex#del
  138.  *
  139.  * @param {String} path - URL path to Apex REST service
  140.  * @param {Object} [body] - Request body
  141.  * @param {Callback.<Object>} [callback] - Callback function
  142.  * @returns {Promise.<Object>}
  143.  */
  144. /**
  145.  * Call Apex REST service in DELETE request
  146.  *
  147.  * @method Apex#delete
  148.  *
  149.  * @param {String} path - URL path to Apex REST service
  150.  * @param {Object} [body] - Request body
  151.  * @param {Object} [options] - Holds headers and other meta data for the request.
  152.  * @param {Callback.<Object>} [callback] - Callback function
  153.  * @returns {Promise.<Object>}
  154.  */
  155. Apex.prototype.del =
  156.   Apex.prototype["delete"] = function(path, options, callback) {
  157.   if (typeof options === 'function') {
  158.     callback = options;
  159.     options = undefined;
  160.   }
  161.   return this._conn.request(this._createRequestParams('DELETE', path, undefined, options)).thenCall(callback);
  162. };
  165. /*--------------------------------------------*/
  166. /*
  167.  * Register hook in connection instantiation for dynamically adding this API module features
  168.  */
  169. jsforce.on('connection:new', function(conn) {
  170.   conn.apex = new Apex(conn);
  171. });
  174. module.exports = Apex;