@jsforce/jsforce-node 0.0.1 → 3.0.0-next.2

package/lib/core.d.ts

@@ -0,0 +1,17 @@
+import jsforce from './jsforce';
+import SfDate from './date';
+import registry, { Registry } from './registry';
+import browser, { BrowserClient } from './browser/client';
+import VERSION from './VERSION';
+import RecordReference from './record-reference';
+import RecordStream from './record-stream';
+export * from './oauth2';
+export * from './jwtOAuth2';
+export * from './connection';
+export * from './query';
+export * from './quick-action';
+export * from './sobject';
+export * from './types';
+export { VERSION, SfDate as Date, SfDate, BrowserClient, RecordReference, RecordStream, registry, browser, };
+export type { Registry };
+export default jsforce;

package/lib/core.js

@@ -0,0 +1,55 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.browser = exports.registry = exports.RecordStream = exports.RecordReference = exports.BrowserClient = exports.SfDate = exports.Date = exports.VERSION = void 0;
+const jsforce_1 = __importDefault(require("./jsforce"));
+const date_1 = __importDefault(require("./date"));
+exports.Date = date_1.default;
+exports.SfDate = date_1.default;
+const registry_1 = __importDefault(require("./registry"));
+exports.registry = registry_1.default;
+const client_1 = __importStar(require("./browser/client"));
+exports.browser = client_1.default;
+Object.defineProperty(exports, "BrowserClient", { enumerable: true, get: function () { return client_1.BrowserClient; } });
+const VERSION_1 = __importDefault(require("./VERSION"));
+exports.VERSION = VERSION_1.default;
+const record_reference_1 = __importDefault(require("./record-reference"));
+exports.RecordReference = record_reference_1.default;
+const record_stream_1 = __importDefault(require("./record-stream"));
+exports.RecordStream = record_stream_1.default;
+__exportStar(require("./oauth2"), exports);
+__exportStar(require("./jwtOAuth2"), exports);
+__exportStar(require("./connection"), exports);
+__exportStar(require("./query"), exports);
+__exportStar(require("./quick-action"), exports);
+__exportStar(require("./sobject"), exports);
+__exportStar(require("./types"), exports);
+exports.default = jsforce_1.default;

package/lib/csv.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+/**
+ *
+ */
+import { Transform } from 'stream';
+import { Options as ParseOpts } from 'csv-parse/sync';
+import { Options as StringifyOpts } from 'csv-stringify';
+/**
+ * @private
+ */
+export declare function parseCSV(str: string, options?: ParseOpts): Object[];
+/**
+ * @private
+ */
+export declare function toCSV(records: Object[], options?: StringifyOpts): string;
+/**
+ * @private
+ */
+export declare function parseCSVStream(options?: ParseOpts): Transform;
+/**
+ * @private
+ */
+export declare function serializeCSVStream(options?: StringifyOpts): Transform;

package/lib/csv.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeCSVStream = exports.parseCSVStream = exports.toCSV = exports.parseCSV = void 0;
+const csv_parse_1 = require("csv-parse");
+const sync_1 = require("csv-parse/sync");
+const csv_stringify_1 = require("csv-stringify");
+const sync_2 = require("csv-stringify/sync");
+/**
+ * @private
+ */
+function parseCSV(str, options) {
+    return (0, sync_1.parse)(str, { ...options, columns: true });
+}
+exports.parseCSV = parseCSV;
+/**
+ * @private
+ */
+function toCSV(records, options) {
+    return (0, sync_2.stringify)(records, { ...options, header: true });
+}
+exports.toCSV = toCSV;
+/**
+ * @private
+ */
+function parseCSVStream(options) {
+    return new csv_parse_1.Parser({ ...options, columns: true });
+}
+exports.parseCSVStream = parseCSVStream;
+/**
+ * @private
+ */
+function serializeCSVStream(options) {
+    return (0, csv_stringify_1.stringify)({ ...options, header: true });
+}
+exports.serializeCSVStream = serializeCSVStream;

package/lib/date.d.ts

@@ -0,0 +1,82 @@
+/**
+ * A date object to keep Salesforce date literal
+ *
+ * @class
+ * @constructor
+ * @see http://www.salesforce.com/us/developer/docs/soql_sosl/Content/sforce_api_calls_soql_select_dateformats.htm
+ */
+export declare class SfDate {
+    private _literal;
+    /**
+     *
+     */
+    constructor(literal: string);
+    /**
+     * Returns literal when converted to string
+     */
+    toJSON(): string;
+    toString: () => string;
+    /**
+     * Convert JavaScript date object to ISO8601 Date format (e.g. 2012-10-31)
+     *
+     * @param {String|Number|Date} date - Input date
+     * @returns {SfDate} - Salesforce date literal with ISO8601 date format
+     */
+    static toDateLiteral(date: string | number | Date): SfDate;
+    /**
+     * Convert JavaScript date object to ISO8601 DateTime format
+     * (e.g. 2012-10-31T12:34:56Z)
+     */
+    static toDateTimeLiteral(date: string | number | Date): SfDate;
+    /**
+     * Convert JavaScript date object to ISO8601 time format
+     * (e.g. 12:34:56.789Z)
+     */
+    static toTimeLiteral(time: string | number | Date): SfDate;
+    /**
+     * Parse IS08601 date(time) formatted string and return date instance
+     */
+    static parseDate(str: string): Date;
+    /**
+     * Parse IS08601 time formatted string and convert to parse string
+     */
+    static parseTime(str: string): Date;
+    static YESTERDAY: SfDate;
+    static TODAY: SfDate;
+    static TOMORROW: SfDate;
+    static LAST_WEEK: SfDate;
+    static THIS_WEEK: SfDate;
+    static NEXT_WEEK: SfDate;
+    static LAST_MONTH: SfDate;
+    static THIS_MONTH: SfDate;
+    static NEXT_MONTH: SfDate;
+    static LAST_90_DAYS: SfDate;
+    static NEXT_90_DAYS: SfDate;
+    static LAST_N_DAYS: (num: number) => SfDate;
+    static NEXT_N_DAYS: (num: number) => SfDate;
+    static NEXT_N_WEEKS: (num: number) => SfDate;
+    static LAST_N_WEEKS: (num: number) => SfDate;
+    static NEXT_N_MONTHS: (num: number) => SfDate;
+    static LAST_N_MONTHS: (num: number) => SfDate;
+    static THIS_QUARTER: SfDate;
+    static LAST_QUARTER: SfDate;
+    static NEXT_QUARTER: SfDate;
+    static NEXT_N_QUARTERS: (num: number) => SfDate;
+    static LAST_N_QUARTERS: (num: number) => SfDate;
+    static THIS_YEAR: SfDate;
+    static LAST_YEAR: SfDate;
+    static NEXT_YEAR: SfDate;
+    static NEXT_N_YEARS: (num: number) => SfDate;
+    static LAST_N_YEARS: (num: number) => SfDate;
+    static THIS_FISCAL_QUARTER: SfDate;
+    static LAST_FISCAL_QUARTER: SfDate;
+    static NEXT_FISCAL_QUARTER: SfDate;
+    static THIS_FISCAL_YEAR: SfDate;
+    static NEXT_N_FISCAL_QUARTERS: (num: number) => SfDate;
+    static LAST_N_FISCAL_QUARTERS: (num: number) => SfDate;
+    static LAST_FISCAL_YEAR: SfDate;
+    static NEXT_FISCAL_YEAR: SfDate;
+    static NEXT_N_FISCAL_YEARS: (num: number) => SfDate;
+    static LAST_N_FISCAL_YEARS: (num: number) => SfDate;
+}
+export default SfDate;

package/lib/date.js

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfDate = void 0;
+/**
+ *
+ */
+const formatter_1 = require("./util/formatter");
+/** @private **/
+function createLiteralBuilder(literal) {
+    return (num) => new SfDate(`${literal}:${String(num)}`); // eslint-disable-line no-use-before-define
+}
+/**
+ * A date object to keep Salesforce date literal
+ *
+ * @class
+ * @constructor
+ * @see http://www.salesforce.com/us/developer/docs/soql_sosl/Content/sforce_api_calls_soql_select_dateformats.htm
+ */
+class SfDate {
+    _literal;
+    /**
+     *
+     */
+    constructor(literal) {
+        this._literal = literal;
+    }
+    /**
+     * Returns literal when converted to string
+     */
+    toJSON() {
+        return this._literal;
+    }
+    toString = this.toJSON;
+    /**
+     * Convert JavaScript date object to ISO8601 Date format (e.g. 2012-10-31)
+     *
+     * @param {String|Number|Date} date - Input date
+     * @returns {SfDate} - Salesforce date literal with ISO8601 date format
+     */
+    static toDateLiteral(date) {
+        let _date;
+        if (typeof date === 'number') {
+            _date = new Date(date);
+        }
+        else if (typeof date === 'string') {
+            _date = SfDate.parseDate(date);
+        }
+        else {
+            _date = date;
+        }
+        const yy = _date.getFullYear();
+        const mm = _date.getMonth() + 1;
+        const dd = _date.getDate();
+        const dstr = [yy, (0, formatter_1.zeroPad)(mm), (0, formatter_1.zeroPad)(dd)].join('-');
+        return new SfDate(dstr);
+    }
+    /**
+     * Convert JavaScript date object to ISO8601 DateTime format
+     * (e.g. 2012-10-31T12:34:56Z)
+     */
+    static toDateTimeLiteral(date) {
+        let _date;
+        if (typeof date === 'number') {
+            _date = new Date(date);
+        }
+        else if (typeof date === 'string') {
+            _date = SfDate.parseDate(date);
+        }
+        else {
+            _date = date;
+        }
+        const yy = _date.getUTCFullYear();
+        const mm = _date.getUTCMonth() + 1;
+        const dd = _date.getUTCDate();
+        const hh = _date.getUTCHours();
+        const mi = _date.getUTCMinutes();
+        const ss = _date.getUTCSeconds();
+        const dtstr = `${[yy, (0, formatter_1.zeroPad)(mm), (0, formatter_1.zeroPad)(dd)].join('-')}T${[
+            (0, formatter_1.zeroPad)(hh),
+            (0, formatter_1.zeroPad)(mi),
+            (0, formatter_1.zeroPad)(ss),
+        ].join(':')}Z`;
+        return new SfDate(dtstr);
+    }
+    /**
+     * Convert JavaScript date object to ISO8601 time format
+     * (e.g. 12:34:56.789Z)
+     */
+    static toTimeLiteral(time) {
+        let _date = new Date(0);
+        if (typeof time === 'string') {
+            _date = SfDate.parseTime(time);
+        }
+        else if (typeof time === 'number') {
+            _date = new Date(time);
+        }
+        else {
+            _date = time;
+        }
+        const hh = _date.getUTCHours();
+        const mi = _date.getUTCMinutes();
+        const ss = _date.getUTCSeconds();
+        const sss = _date.getUTCMilliseconds();
+        const tstr = `${(0, formatter_1.zeroPad)(hh)}:${(0, formatter_1.zeroPad)(mi)}:${(0, formatter_1.zeroPad)(ss)}.${(0, formatter_1.zeroPad)(sss, 3)}Z`;
+        return new SfDate(tstr);
+    }
+    /**
+     * Parse IS08601 date(time) formatted string and return date instance
+     */
+    static parseDate(str) {
+        let d = new Date();
+        const regexp = /^([\d]{4})-?([\d]{2})-?([\d]{2})(T([\d]{2}):?([\d]{2}):?([\d]{2})(.([\d]{3}))?(Z|([+-])([\d]{2}):?([\d]{2})))?$/;
+        const m = str.match(regexp);
+        if (m) {
+            d = new Date(0);
+            if (!m[4]) {
+                d.setFullYear(parseInt(m[1], 10));
+                d.setDate(parseInt(m[3], 10));
+                d.setMonth(parseInt(m[2], 10) - 1);
+                d.setHours(0);
+                d.setMinutes(0);
+                d.setSeconds(0);
+                d.setMilliseconds(0);
+            }
+            else {
+                d.setUTCFullYear(parseInt(m[1], 10));
+                d.setUTCDate(parseInt(m[3], 10));
+                d.setUTCMonth(parseInt(m[2], 10) - 1);
+                d.setUTCHours(parseInt(m[5], 10));
+                d.setUTCMinutes(parseInt(m[6], 10));
+                d.setUTCSeconds(parseInt(m[7], 10));
+                d.setUTCMilliseconds(parseInt(m[9] || '0', 10));
+                if (m[10] && m[10] !== 'Z') {
+                    const offset = parseInt(m[12], 10) * 60 + parseInt(m[13], 10);
+                    d.setTime((m[11] === '+' ? -1 : 1) * offset * 60 * 1000 + d.getTime());
+                }
+            }
+            return d;
+        }
+        throw new Error(`Invalid date format is specified : ${str}`);
+    }
+    /**
+     * Parse IS08601 time formatted string and convert to parse string
+     */
+    static parseTime(str) {
+        const regexp = /^([\d]{2}):?([\d]{2}):?([\d]{2})(.([\d]{3}))?Z?$/;
+        const m = str.match(regexp);
+        if (m) {
+            const d = new Date(0);
+            const hh = parseInt(m[1], 10);
+            const mi = parseInt(m[2], 10);
+            const ss = parseInt(m[3], 10);
+            const sss = parseInt(m[5] || '0', 10);
+            d.setUTCHours(hh);
+            d.setUTCMinutes(mi);
+            d.setUTCSeconds(ss);
+            d.setUTCMilliseconds(sss);
+            return d;
+        }
+        throw new Error(`Invalid time format is specified : ${str}`);
+    }
+    static YESTERDAY = new SfDate('YESTERDAY');
+    static TODAY = new SfDate('TODAY');
+    static TOMORROW = new SfDate('TOMORROW');
+    static LAST_WEEK = new SfDate('LAST_WEEK');
+    static THIS_WEEK = new SfDate('THIS_WEEK');
+    static NEXT_WEEK = new SfDate('NEXT_WEEK');
+    static LAST_MONTH = new SfDate('LAST_MONTH');
+    static THIS_MONTH = new SfDate('THIS_MONTH');
+    static NEXT_MONTH = new SfDate('NEXT_MONTH');
+    static LAST_90_DAYS = new SfDate('LAST_90_DAYS');
+    static NEXT_90_DAYS = new SfDate('NEXT_90_DAYS');
+    static LAST_N_DAYS = createLiteralBuilder('LAST_N_DAYS');
+    static NEXT_N_DAYS = createLiteralBuilder('NEXT_N_DAYS');
+    static NEXT_N_WEEKS = createLiteralBuilder('NEXT_N_WEEKS');
+    static LAST_N_WEEKS = createLiteralBuilder('LAST_N_WEEKS');
+    static NEXT_N_MONTHS = createLiteralBuilder('NEXT_N_MONTHS');
+    static LAST_N_MONTHS = createLiteralBuilder('LAST_N_MONTHS');
+    static THIS_QUARTER = new SfDate('THIS_QUARTER');
+    static LAST_QUARTER = new SfDate('LAST_QUARTER');
+    static NEXT_QUARTER = new SfDate('NEXT_QUARTER');
+    static NEXT_N_QUARTERS = createLiteralBuilder('NEXT_N_QUARTERS');
+    static LAST_N_QUARTERS = createLiteralBuilder('LAST_N_QUARTERS');
+    static THIS_YEAR = new SfDate('THIS_YEAR');
+    static LAST_YEAR = new SfDate('LAST_YEAR');
+    static NEXT_YEAR = new SfDate('NEXT_YEAR');
+    static NEXT_N_YEARS = createLiteralBuilder('NEXT_N_YEARS');
+    static LAST_N_YEARS = createLiteralBuilder('LAST_N_YEARS');
+    static THIS_FISCAL_QUARTER = new SfDate('THIS_FISCAL_QUARTER');
+    static LAST_FISCAL_QUARTER = new SfDate('LAST_FISCAL_QUARTER');
+    static NEXT_FISCAL_QUARTER = new SfDate('NEXT_FISCAL_QUARTER');
+    static THIS_FISCAL_YEAR = new SfDate('THIS_FISCAL_YEAR');
+    static NEXT_N_FISCAL_QUARTERS = createLiteralBuilder('NEXT_N_FISCAL_QUARTERS');
+    static LAST_N_FISCAL_QUARTERS = createLiteralBuilder('LAST_N_FISCAL_QUARTERS');
+    static LAST_FISCAL_YEAR = new SfDate('LAST_FISCAL_YEAR');
+    static NEXT_FISCAL_YEAR = new SfDate('NEXT_FISCAL_YEAR');
+    static NEXT_N_FISCAL_YEARS = createLiteralBuilder('NEXT_N_FISCAL_YEARS');
+    static LAST_N_FISCAL_YEARS = createLiteralBuilder('LAST_N_FISCAL_YEARS');
+}
+exports.SfDate = SfDate;
+exports.default = SfDate;

package/lib/http-api.d.ts

@@ -0,0 +1,75 @@
+/// <reference types="node" />
+/**
+ *
+ */
+import { EventEmitter } from 'events';
+import { Logger } from './util/logger';
+import { StreamPromise } from './util/promise';
+import Connection from './connection';
+import Transport from './transport';
+import { HttpRequest, HttpRequestOptions, HttpResponse, Optional, Schema } from './types';
+/**
+ * HTTP based API class with authorization hook
+ */
+export declare class HttpApi<S extends Schema> extends EventEmitter {
+    static _logger: Logger;
+    _conn: Connection<S>;
+    _logger: Logger;
+    _transport: Transport;
+    _responseType: string | void;
+    _noContentResponse: string | void;
+    _options: HttpRequestOptions;
+    constructor(conn: Connection<S>, options: any);
+    /**
+     * Callout to API endpoint using http
+     */
+    request<R = unknown>(request: HttpRequest): StreamPromise<R>;
+    /**
+     * @protected
+     */
+    getRefreshDelegate(): Optional<import("./session-refresh-delegate").SessionRefreshDelegate<S>>;
+    /**
+     * @protected
+     */
+    beforeSend(request: HttpRequest): void;
+    /**
+     * Detect response content mime-type
+     * @protected
+     */
+    getResponseContentType(response: HttpResponse): Optional<string>;
+    /**
+     * @private
+     */
+    parseResponseBody(response: HttpResponse): Promise<any>;
+    /**
+     * Get response body
+     * @protected
+     */
+    getResponseBody(response: HttpResponse): Promise<any>;
+    /**
+     * Detect session expiry
+     * @protected
+     */
+    isSessionExpired(response: HttpResponse): boolean;
+    /**
+     * Detect error response
+     * @protected
+     */
+    isErrorResponse(response: HttpResponse): boolean;
+    /**
+     * Detect error in response body
+     * @protected
+     */
+    hasErrorInResponseBody(_body: Optional<string>): boolean;
+    /**
+     * Parsing error message in response
+     * @protected
+     */
+    parseError(body: any): any;
+    /**
+     * Get error message in response
+     * @protected
+     */
+    getError(response: HttpResponse, body?: any): Promise<Error>;
+}
+export default HttpApi;