jsforce2
Version:
Salesforce API Library for JavaScript
1,727 lines (1,571 loc) • 2.48 MB
JavaScript
(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.jsforce = f()}})(function(){var define,module,exports;return (function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
'use strict';
var jsforce = require('../core');
jsforce.browser = require('./client');
require('../api');
module.exports = jsforce;
},{"../api":8,"../core":20,"./client":15}],2:[function(require,module,exports){
'use strict';
module.exports = '1.10.0';
},{}],3:[function(require,module,exports){
// This file content is dynamically created in build script
"use strict";
module.exports = {
'inherits': require('inherits'),
'util': require('util'),
'events': require('events'),
'lodash/core': require('lodash/core'),
'readable-stream': require('readable-stream'),
'multistream': require('multistream'),
'./VERSION': require('./VERSION'),
'./cache': require('./cache'),
'./connection': require('./connection'),
'./core': require('./core'),
'./csv': require('./csv'),
'./date': require('./date'),
'./http-api': require('./http-api'),
'./logger': require('./logger'),
'./oauth2': require('./oauth2'),
'./process': require('./process'),
'./promise': require('./promise'),
'./query': require('./query'),
'./quick-action': require('./quick-action'),
'./record-stream': require('./record-stream'),
'./record': require('./record'),
'./soap': require('./soap'),
'./sobject': require('./sobject'),
'./soql-builder': require('./soql-builder'),
'./transport': require('./transport')
};
},{"./VERSION":2,"./cache":18,"./connection":19,"./core":20,"./csv":21,"./date":22,"./http-api":23,"./logger":24,"./oauth2":25,"./process":26,"./promise":27,"./query":28,"./quick-action":29,"./record":31,"./record-stream":30,"./soap":33,"./sobject":34,"./soql-builder":35,"./transport":36,"events":48,"inherits":85,"lodash/core":89,"multistream":90,"readable-stream":108,"util":118}],4:[function(require,module,exports){
/**
* @file Manages Salesforce Analytics API
* @author Shinichi Tomita <shinichi.tomita@gmail.com>
*/
'use strict';
var _ = require('lodash/core'),
jsforce = require('../core'),
Promise = require('../promise');
/**
* Report instance to retrieving asynchronously executed result
*
* @protected
* @class Analytics~ReportInstance
* @param {Analytics~Report} report - Report
* @param {String} id - Report instance id
*/
var ReportInstance = function(report, id) {
this._report = report;
this._conn = report._conn;
this.id = id;
};
/**
* Retrieve report result asynchronously executed
*
* @method Analytics~ReportInstance#retrieve
* @param {Callback.<Analytics~ReportResult>} [callback] - Callback function
* @returns {Promise.<Analytics~ReportResult>}
*/
ReportInstance.prototype.retrieve = function(callback) {
var conn = this._conn,
report = this._report;
var url = [ conn._baseUrl(), "analytics", "reports", report.id, "instances", this.id ].join('/');
return conn.request(url).thenCall(callback);
};
/**
* Report object in Analytics API
*
* @protected
* @class Analytics~Report
* @param {Connection} conn Connection
*/
var Report = function(conn, id) {
this._conn = conn;
this.id = id;
};
/**
* Describe report metadata
*
* @method Analytics~Report#describe
* @param {Callback.<Analytics~ReportMetadata>} [callback] - Callback function
* @returns {Promise.<Analytics~ReportMetadata>}
*/
Report.prototype.describe = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "reports", this.id, "describe" ].join('/');
return this._conn.request(url).thenCall(callback);
};
/**
* Synonym of Analytics~Report#destroy()
*
* @method Analytics~Report#delete
* @param {Callback.<Analytics~ReportResult>} [callback] - Callback function
* @returns {Promise.<Analytics~ReportResult>}
*/
/**
* Synonym of Analytics~Report#destroy()
*
* @method Analytics~Report#del
* @param {Callback.<Analytics~ReportResult>} [callback] - Callback function
* @returns {Promise.<Analytics~ReportResult>}
*/
/**
* Destroy a report
*
* @method Analytics~Report#destroy
* @param {Callback.<Analytics~ReportResult>} [callback] - Callback function
* @returns {Promise.<Analytics~ReportResult>}
*/
Report.prototype["delete"] =
Report.prototype.del =
Report.prototype.destroy = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "reports", this.id ].join('/');
return this._conn.request({method: 'DELETE', url: url}).thenCall(callback);
};
/**
* Clones a given report
*
* @method Analytics~Report#clone
* @param {String} name - The name of the new report
* @param {Callback.<Analytics~ReportResult>} [callback] - Callback function
* @returns {Promise.<Analytics~ReportResult>}
*/
Report.prototype.clone = function(name, callback) {
var url = [ this._conn._baseUrl(), "analytics", "reports" ].join('/');
url += "?cloneId=" + this.id;
var data = { reportMetadata: { name: name } };
var params = { method : 'POST', url: url, headers: { "Content-Type" : "application/json" }, body: JSON.stringify(data)};
return this._conn.request(params).thenCall(callback);
};
/**
* Explain plan for executing report
*
* @method Analytics~Report#explain
* @param {Callback.<ExplainInfo>} [callback] - Callback function
* @returns {Promise.<ExplainInfo>}
*/
Report.prototype.explain = function(callback) {
var url = "/query/?explain=" + this.id;
return this._conn.request(url).thenCall(callback);
};
/**
* Run report synchronously
*
* @method Analytics~Report#execute
* @param {Object} [options] - Options
* @param {Boolean} options.details - Flag if include detail in result
* @param {Analytics~ReportMetadata} options.metadata - Overriding report metadata
* @param {Callback.<Analytics~ReportResult>} [callback] - Callback function
* @returns {Promise.<Analytics~ReportResult>}
*/
Report.prototype.run =
Report.prototype.exec =
Report.prototype.execute = function(options, callback) {
options = options || {};
if (_.isFunction(options)) {
callback = options;
options = {};
}
var url = [ this._conn._baseUrl(), "analytics", "reports", this.id ].join('/');
url += "?includeDetails=" + (options.details ? "true" : "false");
var params = { method : options.metadata ? 'POST' : 'GET', url : url };
if (options.metadata) {
params.headers = { "Content-Type" : "application/json" };
params.body = JSON.stringify(options.metadata);
}
return this._conn.request(params).thenCall(callback);
};
/**
* Run report asynchronously
*
* @method Analytics~Report#executeAsync
* @param {Object} [options] - Options
* @param {Boolean} options.details - Flag if include detail in result
* @param {Analytics~ReportMetadata} options.metadata - Overriding report metadata
* @param {Callback.<Analytics~ReportInstanceAttrs>} [callback] - Callback function
* @returns {Promise.<Analytics~ReportInstanceAttrs>}
*/
Report.prototype.executeAsync = function(options, callback) {
options = options || {};
if (_.isFunction(options)) {
callback = options;
options = {};
}
var url = [ this._conn._baseUrl(), "analytics", "reports", this.id, "instances" ].join('/');
if (options.details) {
url += "?includeDetails=true";
}
var params = { method : 'POST', url : url, body: "" };
if (options.metadata) {
params.headers = { "Content-Type" : "application/json" };
params.body = JSON.stringify(options.metadata);
}
return this._conn.request(params).thenCall(callback);
};
/**
* Get report instance for specified instance ID
*
* @method Analytics~Report#instance
* @param {String} id - Report instance ID
* @returns {Analytics~ReportInstance}
*/
Report.prototype.instance = function(id) {
return new ReportInstance(this, id);
};
/**
* List report instances which had been executed asynchronously
*
* @method Analytics~Report#instances
* @param {Callback.<Array.<Analytics~ReportInstanceAttrs>>} [callback] - Callback function
* @returns {Promise.<Array.<Analytics~ReportInstanceAttrs>>}
*/
Report.prototype.instances = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "reports", this.id, "instances" ].join('/');
return this._conn.request(url).thenCall(callback);
};
/**
* Dashboard object in the Analytics API
*
* @protected
* @class Analytics-Dashboard
* @param {Connection} conn Connection
* @param {String} id - The Id
*/
var Dashboard = function(conn, id) {
this._conn = conn;
this.id = id;
};
/**
* Describe dashboard metadata
*
* @method Analytics~Dashboard#describe
* @param {Callback.<Analytics-DashboardMetadata>} [callback] - Callback function
* @returns {Promise.<Analytics-DashboardMetadata>}
*/
Dashboard.prototype.describe = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "dashboards", this.id, "describe" ].join('/');
return this._conn.request(url).thenCall(callback);
};
/**
* Get details about dashboard components
*
* @method Analytics~Dashboard#components
* @param {Callback.<Analytics-DashboardComponentMetadata>} [callback] - Callback function
* @returns {Promise.<Analytics-DashboardComponentMetadata>}
*/
Dashboard.prototype.components = function(componentIds, callback) {
var url = [ this._conn._baseUrl(), "analytics", "dashboards", this.id].join('/');
var data = {};
if (_.isFunction(componentIds)) {
callback = componentIds;
} else if (_.isArray(componentIds)) {
data.componentIds = componentIds;
} else if (_.isString(componentIds)) {
data.componentIds = [ componentIds ];
}
var params = { method : 'POST', url : url, headers : { "Content-Type" : "application/json" }, body : JSON.stringify(data)};
return this._conn.request(params).thenCall(callback);
};
/**
* Get dashboard status
*
* @method Analytics~Dashboard#status
* @param {Callback.<Analytics-DashboardStatusMetadata>} [callback] - Callback function
* @returns {Promise.<Analytics-DashboardStatusMetadata>}
*/
Dashboard.prototype.status = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "dashboards", this.id, "status" ].join('/');
return this._conn.request(url).thenCall(callback);
};
/**
* Refresh a dashboard
*
* @method Analytics~Dashboard#refresh
* @param {Callback.<Analytics-DashboardStatusUrl>} [callback] - Callback function
* @returns {Promise.<Analytics-DashboardStatusUrl>}
*/
Dashboard.prototype.refresh = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "dashboards", this.id ].join('/');
var params = { method : 'PUT', url : url, body: '' };
return this._conn.request(params).thenCall(callback);
};
/**
* Clone a dashboard
*
* @method Analytics~Dashboard#clone
* @param {Callback.<Analytics-DashboardMetadata>} [callback] - Callback function
* @returns {Promise.<Analytics-DashboardMetadata>}
*/
Dashboard.prototype.clone = function(name, folderid, callback) {
var url = [ this._conn._baseUrl(), "analytics", "dashboards" ].join('/');
url += "?cloneId=" + this.id;
var data = {};
if (_.isObject(name)) {
data = name;
callback = folderid;
} else {
data.name = name;
data.folderId = folderid;
}
var params = { method : 'POST', url : url, headers : { "Content-Type" : "application/json" }, body : JSON.stringify(data)};
return this._conn.request(params).thenCall(callback);
};
/**
* Synonym of Analytics~Dashboard#destroy()
*
* @method Analytics~Dashboard#delete
* @param {Callback.<Analytics~DashboardResult>} [callback] - Callback function
* @returns {Promise.<Analytics~DashboardResult>}
*/
/**
* Synonym of Analytics~Dashboard#destroy()
*
* @method Analytics~Dashboard#del
* @param {Callback.<Analytics~DashboardResult>} [callback] - Callback function
* @returns {Promise.<Analytics~DashboardResult>}
*/
/**
* Destroy a dashboard
*
* @method Analytics~Dashboard#destroy
* @param {Callback.<Analytics~DashboardResult>} [callback] - Callback function
* @returns {Promise.<Analytics~DashboardResult>}
*/
Dashboard.prototype["delete"] =
Dashboard.prototype.del =
Dashboard.prototype.destroy = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "dashboards", this.id ].join('/');
return this._conn.request({method: 'DELETE', url: url}).thenCall(callback);
};
/**
* API class for Analytics API
*
* @class
* @param {Connection} conn Connection
*/
var Analytics = function(conn) {
this._conn = conn;
};
/**
* Get report object of Analytics API
*
* @param {String} id - Report Id
* @returns {Analytics~Report}
*/
Analytics.prototype.report = function(id) {
return new Report(this._conn, id);
};
/**
* Get recent report list
*
* @param {Callback.<Array.<Analytics~ReportInfo>>} [callback] - Callback function
* @returns {Promise.<Array.<Analytics~ReportInfo>>}
*/
Analytics.prototype.reports = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "reports" ].join('/');
return this._conn.request(url).thenCall(callback);
};
/**
* Get dashboard object of Analytics API
*
* @param {String} id - Dashboard Id
* @returns {Analytics~Dashboard}
*/
Analytics.prototype.dashboard = function(id) {
return new Dashboard(this._conn, id);
};
/**
* Get recent dashboard list
*
* @param {Callback.<Array.<Analytics~DashboardInfo>>} [callback] - Callback function
* @returns {Promise.<Array.<Analytics~DashboardInfo>>}
*/
Analytics.prototype.dashboards = function(callback) {
var url = [ this._conn._baseUrl(), "analytics", "dashboards" ].join('/');
return this._conn.request(url).thenCall(callback);
};
/*--------------------------------------------*/
/*
* Register hook in connection instantiation for dynamically adding this API module features
*/
jsforce.on('connection:new', function(conn) {
conn.analytics = new Analytics(conn);
});
module.exports = Analytics;
},{"../core":20,"../promise":27,"lodash/core":89}],5:[function(require,module,exports){
/**
* @file Manages Salesforce Apex REST endpoint calls
* @author Shinichi Tomita <shinichi.tomita@gmail.com>
*/
'use strict';
var jsforce = require('../core');
/**
* API class for Apex REST endpoint call
*
* @class
* @param {Connection} conn Connection
*/
var Apex = function(conn) {
this._conn = conn;
};
/**
* @private
*/
Apex.prototype._baseUrl = function() {
return this._conn.instanceUrl + "/services/apexrest";
};
/**
* @private
*/
Apex.prototype._createRequestParams = function(method, path, body, options) {
var params = {
method: method,
url: this._baseUrl() + path
},
_headers = {};
if(options && 'object' === typeof options['headers']){
_headers = options['headers'];
}
if (!/^(GET|DELETE)$/i.test(method)) {
_headers["Content-Type"] = "application/json";
}
params.headers = _headers;
if (body) {
var contentType = params.headers["Content-Type"];
if (!contentType || contentType === "application/json") {
params.body = JSON.stringify(body);
} else {
params.body = body;
}
}
return params;
};
/**
* Call Apex REST service in GET request
*
* @param {String} path - URL path to Apex REST service
* @param {Object} options - Holds headers and other meta data for the request.
* @param {Callback.<Object>} [callback] - Callback function
* @returns {Promise.<Object>}
*/
Apex.prototype.get = function(path, options, callback) {
if (typeof options === 'function') {
callback = options;
options = undefined;
}
return this._conn.request(this._createRequestParams('GET', path, undefined, options)).thenCall(callback);
};
/**
* Call Apex REST service in POST request
*
* @param {String} path - URL path to Apex REST service
* @param {Object} [body] - Request body
* @param {Object} options - Holds headers and other meta data for the request.
* @param {Callback.<Object>} [callback] - Callback function
* @returns {Promise.<Object>}
*/
Apex.prototype.post = function(path, body, options, callback) {
if (typeof body === 'function') {
callback = body;
body = undefined;
options = undefined;
}
if (typeof options === 'function') {
callback = options;
options = undefined;
}
var params = this._createRequestParams('POST', path, body, options);
return this._conn.request(params).thenCall(callback);
};
/**
* Call Apex REST service in PUT request
*
* @param {String} path - URL path to Apex REST service
* @param {Object} [body] - Request body
* @param {Object} [options] - Holds headers and other meta data for the request.
* @param {Callback.<Object>} [callback] - Callback function
* @returns {Promise.<Object>}
*/
Apex.prototype.put = function(path, body, options, callback) {
if (typeof body === 'function') {
callback = body;
body = undefined;
options = undefined;
}
if (typeof options === 'function') {
callback = options;
options = undefined;
}
var params = this._createRequestParams('PUT', path, body, options);
return this._conn.request(params).thenCall(callback);
};
/**
* Call Apex REST service in PATCH request
*
* @param {String} path - URL path to Apex REST service
* @param {Object} [body] - Request body
* @param {Object} [options] - Holds headers and other meta data for the request.
* @param {Callback.<Object>} [callback] - Callback function
* @returns {Promise.<Object>}
*/
Apex.prototype.patch = function(path, body, options, callback) {
if (typeof body === 'function') {
callback = body;
body = undefined;
options = undefined;
}
if (typeof options === 'function') {
callback = options;
options = undefined;
}
var params = this._createRequestParams('PATCH', path, body, options);
return this._conn.request(params).thenCall(callback);
};
/**
* Synonym of Apex#delete()
*
* @method Apex#del
*
* @param {String} path - URL path to Apex REST service
* @param {Callback.<Object>} [callback] - Callback function
* @returns {Promise.<Object>}
*/
/**
* Call Apex REST service in DELETE request
*
* @method Apex#delete
*
* @param {String} path - URL path to Apex REST service
* @param {Object} [options] - Holds headers and other meta data for the request.
* @param {Callback.<Object>} [callback] - Callback function
* @returns {Promise.<Object>}
*/
Apex.prototype.del =
Apex.prototype["delete"] = function(path, options, callback) {
if (typeof options === 'function') {
callback = options;
options = undefined;
}
return this._conn.request(this._createRequestParams('DELETE', path, undefined, options)).thenCall(callback);
};
/*--------------------------------------------*/
/*
* Register hook in connection instantiation for dynamically adding this API module features
*/
jsforce.on('connection:new', function(conn) {
conn.apex = new Apex(conn);
});
module.exports = Apex;
},{"../core":20}],6:[function(require,module,exports){
(function (process){
/*global process*/
/**
* @file Manages Salesforce Bulk API related operations
* @author Shinichi Tomita <shinichi.tomita@gmail.com>
*/
'use strict';
var inherits = require('inherits'),
stream = require('readable-stream'),
Duplex = stream.Duplex,
events = require('events'),
_ = require('lodash/core'),
joinStreams = require('multistream'),
jsforce = require('../core'),
RecordStream = require('../record-stream'),
Promise = require('../promise'),
HttpApi = require('../http-api');
/*--------------------------------------------*/
/**
* Class for Bulk API Job
*
* @protected
* @class Bulk~Job
* @extends events.EventEmitter
*
* @param {Bulk} bulk - Bulk API object
* @param {String} [type] - SObject type
* @param {String} [operation] - Bulk load operation ('insert', 'update', 'upsert', 'delete', or 'hardDelete')
* @param {Object} [options] - Options for bulk loading operation
* @param {String} [options.extIdField] - External ID field name (used when upsert operation).
* @param {String} [options.concurrencyMode] - 'Serial' or 'Parallel'. Defaults to Parallel.
* @param {String} [jobId] - Job ID (if already available)
*/
var Job = function(bulk, type, operation, options, jobId) {
this._bulk = bulk;
this.type = type;
this.operation = operation;
this.options = options || {};
this.id = jobId;
this.state = this.id ? 'Open' : 'Unknown';
this._batches = {};
};
inherits(Job, events.EventEmitter);
/**
* @typedef {Object} Bulk~JobInfo
* @prop {String} id - Job ID
* @prop {String} object - Object type name
* @prop {String} operation - Operation type of the job
* @prop {String} state - Job status
*/
/**
* Return latest jobInfo from cache
*
* @method Bulk~Job#info
* @param {Callback.<Bulk~JobInfo>} [callback] - Callback function
* @returns {Promise.<Bulk~JobInfo>}
*/
Job.prototype.info = function(callback) {
var self = this;
// if cache is not available, check the latest
if (!this._jobInfo) {
this._jobInfo = this.check();
}
return this._jobInfo.thenCall(callback);
};
/**
* Open new job and get jobinfo
*
* @method Bulk~Job#open
* @param {Callback.<Bulk~JobInfo>} [callback] - Callback function
* @returns {Promise.<Bulk~JobInfo>}
*/
Job.prototype.open = function(callback) {
var self = this;
var bulk = this._bulk;
var logger = bulk._logger;
// if not requested opening job
if (!this._jobInfo) {
var operation = this.operation.toLowerCase();
if (operation === 'harddelete') { operation = 'hardDelete'; }
var body = [
'<?xml version="1.0" encoding="UTF-8"?>',
'<jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">',
'<operation>' + operation + '</operation>',
'<object>' + this.type + '</object>',
(this.options.extIdField ?
'<externalIdFieldName>'+this.options.extIdField+'</externalIdFieldName>' :
''),
(this.options.concurrencyMode ?
'<concurrencyMode>'+this.options.concurrencyMode+'</concurrencyMode>' :
''),
(this.options.assignmentRuleId ?
'<assignmentRuleId>' + this.options.assignmentRuleId + '</assignmentRuleId>' :
''),
'<contentType>CSV</contentType>',
'</jobInfo>'
].join('');
this._jobInfo = bulk._request({
method : 'POST',
path : "/job",
body : body,
headers : {
"Content-Type" : "application/xml; charset=utf-8"
},
responseType: "application/xml"
}).then(function(res) {
self.emit("open", res.jobInfo);
self.id = res.jobInfo.id;
self.state = res.jobInfo.state;
return res.jobInfo;
}, function(err) {
self.emit("error", err);
throw err;
});
}
return this._jobInfo.thenCall(callback);
};
/**
* Create a new batch instance in the job
*
* @method Bulk~Job#createBatch
* @returns {Bulk~Batch}
*/
Job.prototype.createBatch = function() {
var batch = new Batch(this);
var self = this;
batch.on('queue', function() {
self._batches[batch.id] = batch;
});
return batch;
};
/**
* Get a batch instance specified by given batch ID
*
* @method Bulk~Job#batch
* @param {String} batchId - Batch ID
* @returns {Bulk~Batch}
*/
Job.prototype.batch = function(batchId) {
var batch = this._batches[batchId];
if (!batch) {
batch = new Batch(this, batchId);
this._batches[batchId] = batch;
}
return batch;
};
/**
* Check the latest job status from server
*
* @method Bulk~Job#check
* @param {Callback.<Bulk~JobInfo>} [callback] - Callback function
* @returns {Promise.<Bulk~JobInfo>}
*/
Job.prototype.check = function(callback) {
var self = this;
var bulk = this._bulk;
var logger = bulk._logger;
this._jobInfo = this._waitAssign().then(function() {
return bulk._request({
method : 'GET',
path : "/job/" + self.id,
responseType: "application/xml"
});
}).then(function(res) {
logger.debug(res.jobInfo);
self.id = res.jobInfo.id;
self.type = res.jobInfo.object;
self.operation = res.jobInfo.operation;
self.state = res.jobInfo.state;
return res.jobInfo;
});
return this._jobInfo.thenCall(callback);
};
/**
* Wait till the job is assigned to server
*
* @method Bulk~Job#info
* @param {Callback.<Bulk~JobInfo>} [callback] - Callback function
* @returns {Promise.<Bulk~JobInfo>}
*/
Job.prototype._waitAssign = function(callback) {
return (this.id ? Promise.resolve({ id: this.id }) : this.open()).thenCall(callback);
};
/**
* List all registered batch info in job
*
* @method Bulk~Job#list
* @param {Callback.<Array.<Bulk~BatchInfo>>} [callback] - Callback function
* @returns {Promise.<Array.<Bulk~BatchInfo>>}
*/
Job.prototype.list = function(callback) {
var self = this;
var bulk = this._bulk;
var logger = bulk._logger;
return this._waitAssign().then(function() {
return bulk._request({
method : 'GET',
path : "/job/" + self.id + "/batch",
responseType: "application/xml"
});
}).then(function(res) {
logger.debug(res.batchInfoList.batchInfo);
var batchInfoList = res.batchInfoList;
batchInfoList = _.isArray(batchInfoList.batchInfo) ? batchInfoList.batchInfo : [ batchInfoList.batchInfo ];
return batchInfoList;
}).thenCall(callback);
};
/**
* Close opened job
*
* @method Bulk~Job#close
* @param {Callback.<Bulk~JobInfo>} [callback] - Callback function
* @returns {Promise.<Bulk~JobInfo>}
*/
Job.prototype.close = function() {
var self = this;
return this._changeState("Closed").then(function(jobInfo) {
self.id = null;
self.emit("close", jobInfo);
return jobInfo;
}, function(err) {
self.emit("error", err);
throw err;
});
};
/**
* Set the status to abort
*
* @method Bulk~Job#abort
* @param {Callback.<Bulk~JobInfo>} [callback] - Callback function
* @returns {Promise.<Bulk~JobInfo>}
*/
Job.prototype.abort = function() {
var self = this;
return this._changeState("Aborted").then(function(jobInfo) {
self.id = null;
self.emit("abort", jobInfo);
return jobInfo;
}, function(err) {
self.emit("error", err);
throw err;
});
};
/**
* @private
*/
Job.prototype._changeState = function(state, callback) {
var self = this;
var bulk = this._bulk;
var logger = bulk._logger;
this._jobInfo = this._waitAssign().then(function() {
var body = [
'<?xml version="1.0" encoding="UTF-8"?>',
'<jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">',
'<state>' + state + '</state>',
'</jobInfo>'
].join('');
return bulk._request({
method : 'POST',
path : "/job/" + self.id,
body : body,
headers : {
"Content-Type" : "application/xml; charset=utf-8"
},
responseType: "application/xml"
});
}).then(function(res) {
logger.debug(res.jobInfo);
self.state = res.jobInfo.state;
return res.jobInfo;
});
return this._jobInfo.thenCall(callback);
};
/*--------------------------------------------*/
/**
* Batch (extends RecordStream)
*
* @protected
* @class Bulk~Batch
* @extends {stream.Writable}
* @implements {Promise.<Array.<RecordResult>>}
* @param {Bulk~Job} job - Bulk job object
* @param {String} [batchId] - Batch ID (if already available)
*/
var Batch = function(job, batchId) {
Batch.super_.call(this, { objectMode: true });
this.job = job;
this.id = batchId;
this._bulk = job._bulk;
this._deferred = Promise.defer();
this._setupDataStreams();
};
inherits(Batch, stream.Writable);
/**
* @private
*/
Batch.prototype._setupDataStreams = function() {
var batch = this;
var converterOptions = { nullValue : '#N/A' };
this._uploadStream = new RecordStream.Serializable();
this._uploadDataStream = this._uploadStream.stream('csv', converterOptions);
this._downloadStream = new RecordStream.Parsable();
this._downloadDataStream = this._downloadStream.stream('csv', converterOptions);
this.on('finish', function() {
batch._uploadStream.end();
});
this._uploadDataStream.once('readable', function() {
batch.job.open().then(function() {
// pipe upload data to batch API request stream
batch._uploadDataStream.pipe(batch._createRequestStream());
});
});
// duplex data stream, opened access to API programmers by Batch#stream()
var dataStream = this._dataStream = new Duplex();
dataStream._write = function(data, enc, cb) {
batch._uploadDataStream.write(data, enc, cb);
};
dataStream.on('finish', function() {
batch._uploadDataStream.end();
});
this._downloadDataStream.on('readable', function() {
dataStream.read(0);
});
this._downloadDataStream.on('end', function() {
dataStream.push(null);
});
dataStream._read = function(size) {
var chunk;
while ((chunk = batch._downloadDataStream.read()) !== null) {
dataStream.push(chunk);
}
};
};
/**
* Connect batch API and create stream instance of request/response
*
* @private
* @returns {stream.Duplex}
*/
Batch.prototype._createRequestStream = function() {
var batch = this;
var bulk = batch._bulk;
var logger = bulk._logger;
return bulk._request({
method : 'POST',
path : "/job/" + batch.job.id + "/batch",
headers: {
"Content-Type": "text/csv"
},
responseType: "application/xml"
}, function(err, res) {
if (err) {
batch.emit('error', err);
} else {
logger.debug(res.batchInfo);
batch.id = res.batchInfo.id;
batch.emit('queue', res.batchInfo);
}
}).stream();
};
/**
* Implementation of Writable
*
* @override
* @private
*/
Batch.prototype._write = function(record, enc, cb) {
record = _.clone(record);
if (this.job.operation === "insert") {
delete record.Id;
} else if (this.job.operation === "delete") {
record = { Id: record.Id };
}
delete record.type;
delete record.attributes;
this._uploadStream.write(record, enc, cb);
};
/**
* Returns duplex stream which accepts CSV data input and batch result output
*
* @returns {stream.Duplex}
*/
Batch.prototype.stream = function() {
return this._dataStream;
};
/**
* Execute batch operation
*
* @method Bulk~Batch#execute
* @param {Array.<Record>|stream.Stream|String} [input] - Input source for batch operation. Accepts array of records, CSV string, and CSV data input stream in insert/update/upsert/delete/hardDelete operation, SOQL string in query operation.
* @param {Callback.<Array.<RecordResult>|Array.<BatchResultInfo>>} [callback] - Callback function
* @returns {Bulk~Batch}
*/
Batch.prototype.run =
Batch.prototype.exec =
Batch.prototype.execute = function(input, callback) {
var self = this;
if (typeof input === 'function') { // if input argument is omitted
callback = input;
input = null;
}
// if batch is already executed
if (this._result) {
throw new Error("Batch already executed.");
}
var rdeferred = Promise.defer();
this._result = rdeferred.promise;
this._result.then(function(res) {
self._deferred.resolve(res);
}, function(err) {
self._deferred.reject(err);
});
this.once('response', function(res) {
rdeferred.resolve(res);
});
this.once('error', function(err) {
rdeferred.reject(err);
});
if (_.isObject(input) && _.isFunction(input.pipe)) { // if input has stream.Readable interface
input.pipe(this._dataStream);
} else {
var data;
if (_.isArray(input)) {
_.forEach(input, function(record) {
Object.keys(record).forEach(function(key) {
if (typeof record[key] === 'boolean') {
record[key] = String(record[key])
}
})
self.write(record);
});
self.end();
} else if (_.isString(input)){
data = input;
this._dataStream.write(data, 'utf8');
this._dataStream.end();
}
}
// return Batch instance for chaining
return this.thenCall(callback);
};
/**
* Promise/A+ interface
* http://promises-aplus.github.io/promises-spec/
*
* Delegate to deferred promise, return promise instance for batch result
*
* @method Bulk~Batch#then
*/
Batch.prototype.then = function(onResolved, onReject, onProgress) {
return this._deferred.promise.then(onResolved, onReject, onProgress);
};
/**
* Promise/A+ extension
* Call "then" using given node-style callback function
*
* @method Bulk~Batch#thenCall
*/
Batch.prototype.thenCall = function(callback) {
if (_.isFunction(callback)) {
this.then(function(res) {
process.nextTick(function() {
callback(null, res);
});
}, function(err) {
process.nextTick(function() {
callback(err);
});
});
}
return this;
};
/**
* @typedef {Object} Bulk~BatchInfo
* @prop {String} id - Batch ID
* @prop {String} jobId - Job ID
* @prop {String} state - Batch state
* @prop {String} stateMessage - Batch state message
*/
/**
* Check the latest batch status in server
*
* @method Bulk~Batch#check
* @param {Callback.<Bulk~BatchInfo>} [callback] - Callback function
* @returns {Promise.<Bulk~BatchInfo>}
*/
Batch.prototype.check = function(callback) {
var self = this;
var bulk = this._bulk;
var logger = bulk._logger;
var jobId = this.job.id;
var batchId = this.id;
if (!jobId || !batchId) {
throw new Error("Batch not started.");
}
return bulk._request({
method : 'GET',
path : "/job/" + jobId + "/batch/" + batchId,
responseType: "application/xml"
}).then(function(res) {
logger.debug(res.batchInfo);
return res.batchInfo;
}).thenCall(callback);
};
/**
* Polling the batch result and retrieve
*
* @method Bulk~Batch#poll
* @param {Number} interval - Polling interval in milliseconds
* @param {Number} timeout - Polling timeout in milliseconds
*/
Batch.prototype.poll = function(interval, timeout) {
var self = this;
var jobId = this.job.id;
var batchId = this.id;
if (!jobId || !batchId) {
throw new Error("Batch not started.");
}
var startTime = new Date().getTime();
var poll = function() {
var now = new Date().getTime();
if (startTime + timeout < now) {
var err = new Error("Polling time out. Job Id = " + jobId + " , batch Id = " + batchId);
err.name = 'PollingTimeout';
err.jobId = jobId;
err.batchId = batchId;
self.emit('error', err);
return;
}
self.check(function(err, res) {
if (err) {
self.emit('error', err);
} else {
if (res.state === "Failed") {
if (parseInt(res.numberRecordsProcessed, 10) > 0) {
self.retrieve();
} else {
self.emit('error', new Error(res.stateMessage));
}
} else if (res.state === "Completed") {
self.retrieve();
} else {
self.emit('progress', res);
setTimeout(poll, interval);
}
}
});
};
setTimeout(poll, interval);
};
/**
* @typedef {Object} Bulk~BatchResultInfo
* @prop {String} id - Batch result ID
* @prop {String} batchId - Batch ID which includes this batch result.
* @prop {String} jobId - Job ID which includes this batch result.
*/
/**
* Retrieve batch result
*
* @method Bulk~Batch#retrieve
* @param {Callback.<Array.<RecordResult>|Array.<Bulk~BatchResultInfo>>} [callback] - Callback function
* @returns {Promise.<Array.<RecordResult>|Array.<Bulk~BatchResultInfo>>}
*/
Batch.prototype.retrieve = function(callback) {
var self = this;
var bulk = this._bulk;
var jobId = this.job.id;
var job = this.job;
var batchId = this.id;
if (!jobId || !batchId) {
throw new Error("Batch not started.");
}
return job.info().then(function(jobInfo) {
return bulk._request({
method : 'GET',
path : "/job/" + jobId + "/batch/" + batchId + "/result"
});
}).then(function(res) {
var results;
if (job.operation === 'query') {
var conn = bulk._conn;
var resultIds = res['result-list'].result;
results = res['result-list'].result;
results = _.map(_.isArray(results) ? results : [ results ], function(id) {
return {
id: id,
batchId: batchId,
jobId: jobId
};
});
} else {
results = _.map(res, function(ret) {
return {
id: ret.Id || null,
success: ret.Success === "true",
errors: ret.Error ? [ ret.Error ] : []
};
});
}
self.emit('response', results);
return results;
}).fail(function(err) {
self.emit('error', err);
throw err;
}).thenCall(callback);
};
/**
* Fetch query result as a record stream
* @param {String} resultId - Result id
* @returns {RecordStream} - Record stream, convertible to CSV data stream
*/
Batch.prototype.result = function(resultId) {
var jobId = this.job.id;
var batchId = this.id;
if (!jobId || !batchId) {
throw new Error("Batch not started.");
}
var resultStream = new RecordStream.Parsable();
var resultDataStream = resultStream.stream('csv');
var reqStream = this._bulk._request({
method : 'GET',
path : "/job/" + jobId + "/batch/" + batchId + "/result/" + resultId,
responseType: "application/octet-stream"
}).stream().pipe(resultDataStream);
return resultStream;
};
/*--------------------------------------------*/
/**
* @private
*/
var BulkApi = function() {
BulkApi.super_.apply(this, arguments);
};
inherits(BulkApi, HttpApi);
BulkApi.prototype.beforeSend = function(request) {
request.headers = request.headers || {};
request.headers["X-SFDC-SESSION"] = this._conn.accessToken;
};
BulkApi.prototype.isSessionExpired = function(response) {
return response.statusCode === 400 &&
/<exceptionCode>InvalidSessionId<\/exceptionCode>/.test(response.body);
};
BulkApi.prototype.hasErrorInResponseBody = function(body) {
return !!body.error;
};
BulkApi.prototype.parseError = function(body) {
return {
errorCode: body.error.exceptionCode,
message: body.error.exceptionMessage
};
};
/*--------------------------------------------*/
/**
* Class for Bulk API
*
* @class
* @param {Connection} conn - Connection object
*/
var Bulk = function(conn) {
this._conn = conn;
this._logger = conn._logger;
};
/**
* Polling interval in milliseconds
* @type {Number}
*/
Bulk.prototype.pollInterval = 1000;
/**
* Polling timeout in milliseconds
* @type {Number}
*/
Bulk.prototype.pollTimeout = 10000;
/** @private **/
Bulk.prototype._request = function(request, callback) {
var conn = this._conn;
request = _.clone(request);
var baseUrl = [ conn.instanceUrl, "services/async", conn.version ].join('/');
request.url = baseUrl + request.path;
var options = { responseType: request.responseType };
delete request.path;
delete request.responseType;
return new BulkApi(this._conn, options).request(request).thenCall(callback);
};
/**
* Create and start bulkload job and batch
*
* @param {String} type - SObject type
* @param {String} operation - Bulk load operation ('insert', 'update', 'upsert', 'delete', or 'hardDelete')
* @param {Object} [options] - Options for bulk loading operation
* @param {String} [options.extIdField] - External ID field name (used when upsert operation).
* @param {String} [options.concurrencyMode] - 'Serial' or 'Parallel'. Defaults to Parallel.
* @param {Array.<Record>|stream.Stream|String} [input] - Input source for bulkload. Accepts array of records, CSV string, and CSV data input stream in insert/update/upsert/delete/hardDelete operation, SOQL string in query operation.
* @param {Callback.<Array.<RecordResult>|Array.<Bulk~BatchResultInfo>>} [callback] - Callback function
* @returns {Bulk~Batch}
*/
Bulk.prototype.load = function(type, operation, options, input, callback) {
var self = this;
if (!type || !operation) {
throw new Error("Insufficient arguments. At least, 'type' and 'operation' are required.");
}
if (!_.isObject(options) || options.constructor !== Object) { // when options is not plain hash object, it is omitted
callback = input;
input = options;
options = null;
}
var job = this.createJob(type, operation, options);
job.once('error', function (error) {
if (batch) {
batch.emit('error', error); // pass job error to batch
}
});
var batch = job.createBatch();
var cleanup = function() {
batch = null;
job.close();
};
var cleanupOnError = function(err) {
if (err.name !== 'PollingTimeout') {
cleanup();
}
};
batch.on('response', cleanup);
batch.on('error', cleanupOnError);
batch.on('queue', function() { batch.poll(self.pollInterval, self.pollTimeout); });
return batch.execute(input, callback);
};
/**
* Execute bulk query and get record stream
*
* @param {String} soql - SOQL to execute in bulk job
* @returns {RecordStream.Parsable} - Record stream, convertible to CSV data stream
*/
Bulk.prototype.query = function(soql) {
var m = soql.replace(/\([\s\S]+\)/g, '').match(/FROM\s+(\w+)/i);
if (!m) {
throw new Error("No sobject type found in query, maybe caused by invalid SOQL.");
}
var type = m[1];
var self = this;
var recordStream = new RecordStream.Parsable();
var dataStream = recordStream.stream('csv');
this.load(type, "query", soql).then(function(results) {
var streams = results.map(function(result) {
return self
.job(result.jobId)
.batch(result.batchId)
.result(result.id)
.stream();
});
joinStreams(streams).pipe(dataStream);
}).fail(function(err) {
recordStream.emit('error', err);
});
return recordStream;
};
/**
* Create a new job instance
*
* @param {String} type - SObject type
* @param {String} operation - Bulk load operation ('insert', 'update', 'upsert', 'delete', 'hardDelete', or 'query')
* @param {Object} [options] - Options for bulk loading operation
* @returns {Bulk~Job}
*/
Bulk.prototype.createJob = function(type, operation, options) {
return new Job(this, type, operation, options);
};
/**
* Get a job instance specified by given job ID
*
* @param {String} jobId - Job ID
* @returns {Bulk~Job}
*/
Bulk.prototype.job = function(jobId) {
return new Job(this, null, null, null, jobId);
};
/*--------------------------------------------*/
/*
* Register hook in connection instantiation for dynamically adding this API module features
*/
jsforce.on('connection:new', function(conn) {
conn.bulk = new Bulk(conn);
});
module.exports = Bulk;
}).call(this,require('_process'))
},{"../core":20,"../http-api":23,"../promise":27,"../record-stream":30,"_process":92,"events":48,"inherits":85,"lodash/core":89,"multistream":90,"readable-stream":108}],7:[function(require,module,exports){
/**
* @file Manages Salesforce Chatter REST API calls
* @author Shinichi Tomita <shinichi.tomita@gmail.com>
*/
'use strict';
var inherits = require('inherits'),
_ = require('lodash/core'),
jsforce = require('../core'),
Promise = require('../promise');
/**
* API class for Chatter REST API call
*
* @class
* @param {Connection} conn Connection
*/
var Chatter = module.exports = function(conn) {
this._conn = conn;
};
/**
* Sending request to API endpoint
* @private
*/
Chatter.prototype._request = function(params, callback) {
if (/^(put|post|patch)$/i.test(params.method)) {
if (_.isObject(params.body)) {
params.headers = {
"Content-Type": "application/json"
};
params.body = JSON.stringify(params.body);
}
}
params.url = this._normalizeUrl(params.url);
return this._conn.request(params, callback);
};
/**
* Convert path to site root relative url
* @private
*/
Chatter.prototype._normalizeUrl = function(url) {
if (url.indexOf('/chatter/') === 0 || url.indexOf('/connect/') === 0) {
return '/services/data/v' + this._conn.version + url;
} else if (/^\/v[\d]+\.[\d]+\//.test(url)) {
return '/services/data' + url;
} else if (url.indexOf('/services/') !== 0 && url[0] === '/') {
return '/services/data/v' + this._conn.version + '/chatter' + url;
} else {
return url;
}
};
/**
* @typedef {Object} Chatter~RequestParams
* @prop {String} method - HTTP method
* @prop {String} url - Resource URL
* @prop {String} [body] - HTTP body (in POST/PUT/PATCH methods)
*/
/**
* @typedef {Object} Chatter~RequestResult
*/
/**
* Make a request for chatter API resource
*
* @param {Chatter~RequestParams} params - Paramters representing HTTP request
* @param {Callback.<Chatter~RequestResult>} [callback] - Callback func
* @returns {Chatter~Request}
*/
Chatter.prototype.request = function(params, callback) {
return new Request(this, params).thenCall(callback);
};
/**
* Make a resource request to chatter API
*
* @param {String} url - Resource URL
* @param {Object} [queryParams] - Query parameters (in hash object)
* @returns {Chatter~Resource}
*/
Chatter.prototype.resource = function(url, queryParams) {
return new Resource(this, url, queryParams);
};
/**
* @typedef {Object} Chatter~BatchRequestResult
* @prop {Boolean} hasError - Flag if the batch has one or more errors
* @prop {Array.<Object>} results - Batch request results in array
* @prop {Number} results.statusCode - HTTP response status code
* @prop {Chatter~RequestResult} results.result - Parsed HTTP response body
*/
/**
* Make a batch request to chatter API
*
* @params {Array.<Chatter~Request>} requests - Chatter API requests
* @param {Callback.<Chatter~BatchRequestResult>} [callback] - Callback func
* @returns {Promise.<Chatter~BatchRequestResult>}
*/
Chatter.prototype.batch = function(requests, callback) {
var self = this;
var batchRequests = [], batchDeferreds = [];
_.forEach(requests, function(request) {
var deferred = Promise.defer();
request._promise = deferred.promise;
batchRequests.push(request.batchParams());
batchDeferreds.push(deferred);
});
var params = {
method: 'POST',
url: this._normalizeUrl('/connect/batch'),
body: {
batchRequests: batchRequests
}
};
return this.request(params).then(function(res) {
_.forEach(res.results, function(result, i) {
var deferred = batchDeferreds[i];
if (result.statusCode >= 400) {
deferred.reject(result.result);
} else {
deferred.resolve(result.result);
}
});
return res;
}).thenCall(callback);
};
/*--------------------------------------------*/
/**
* A class representing chatter API request
*
* @protected
* @class Chatter~Request
* @implements {Promise.<Chatter~RequestResult>}
* @param {Chatter} chatter - Chatter API object
* @param {Chatter~RequestParams} params - Paramters representing HTTP request
*/
var Request = function(chatter, params) {
this._chatter = chatter;
this._params = params;
this._promise = null;
};
/**
* @typedef {Object} Chatter~BatchRequestParams
* @prop {String} method - HTTP method
* @prop {String} url - Resource URL
* @prop {String} [richInput] - HTTP body (in POST/PUT/PATCH methods)
*/
/**
* Retrieve parameters in batch request form
*
* @method Chatter~Request#batchParams
* @returns {Chatter~BatchRequestParams}
*/
Request.prototype.batchParams = function() {
var params = this._params;
var batchParams = {
method: params.method,
url: this._chatter._normalizeUrl(params.url)
};
if (this._params.body) {
batchParams.richInput = this._params.body;
}
return batchParams;
};
/**
* Retrieve parameters in batch request form
*
* @method Chatter~Request#promise
* @returns {Promise.<Chatter~RequestResult>}
*/
Request.prototype.promise = function() {
return this._promise || this._chatter._request(this._params);
};
/**
* Returns Node.js Stream object for request
*
* @method Chatter~Request#stream
* @returns {stream.Stream}
*/
Request.prototype.stream = function() {
return this._chatter._request(this._params).stream();
};
/**
* Promise/A+ interface
* http://promises-aplus.github.io/promises-spec/
*
* Delegate to deferred promise, return promise instance for batch result
*
* @method Chatter~Request#then
*/
Request.prototype.then = function(onResolve, onReject) {
return this.promise().then(onResolve, onReject);
};
/**
* Promise/A+ extension
* Call "then" using given node-style callback function
*
* @method Chatter~Request#thenCall
*/
Request.prototype.thenCall = function(callback) {
return _.isFunction(callback) ? this.promise().thenCall(callback) : this;
};
/*--------------------------------------------*/
/**
* A class representing chatter API resource
*
* @protected
* @class Chatter~Resource
* @extends Chatter~Request
* @param {Chatter} chatter - Chatter API object
* @param {String} url - Resource URL
* @param {Object} [queryParams] - Query parameters (in hash object)
*/
var Resource = function(chatter, url, queryParams) {
if (queryParams) {
var qstring = _.map(_.keys(queryParams), function(name) {
return name + "=" + encodeURIComponent(queryParams[name]);
}).join('&');
url += (url.indexOf('?') > 0 ? '&' : '?') + qstring;
}
Resource.super_.call(this, chatter, { method: 'GET', url: url });
this._url = url;
};
inherits(Resource, Request);
/**
* Create a new resource
*
* @method Chatter~Resource#create
* @param {Object} data - Data to newly post
* @param {Callback.<Chatter~RequestResult>} [callback] - Callback function
* @returns {Chatter~Request}
*/
Resource.prototype.create = function(data, callback) {
return this._chatter.request({