@jsforce/jsforce-node 3.5.2 → 3.6.1

package/README.md

@@ -32,6 +32,11 @@ https://jsforce.github.io/jsforce/
 v1 API reference:
 https://jsforce.github.io/jsforce/doc/
 
+## Migration
+Migrating from v1 → v3? Find the [migration guide here](./MIGRATING_V1-V3.md)
+
+Migrating from v2 → v3? Find the [migration guide here](./MIGRATING_V2-V3.md)
+
 ## Releases
 
 See [Releases](https://github.com/jsforce/jsforce/releases).

package/lib/VERSION.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "3.5.2";
+declare const _default: "3.6.1";
 export default _default;

package/lib/VERSION.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '3.5.2';
+exports.default = '3.6.1';

package/lib/api/bulk2.d.ts

@@ -291,28 +291,60 @@ export declare class IngestJobV2<S extends Schema> extends EventEmitter {
      *
      * The order of records returned is not guaranteed to match the ordering of the uploaded data.
      *
+     * @param {boolean} raw Get results as a CSV string
      * @returns Promise<IngestJobV2SuccessfulResults>
      */
-    getSuccessfulResults(): Promise<IngestJobV2SuccessfulResults<S>>;
+    getSuccessfulResults(raw?: false): Promise<IngestJobV2SuccessfulResults<S>>;
+    /** Return successful results
+     *
+     * The order of records returned is not guaranteed to match the ordering of the uploaded data.
+     *
+     * @param {boolean} raw Get results as a CSV string
+     * @returns Promise<string>
+     */
+    getSuccessfulResults(raw: true): Promise<string>;
     /** Return failed results
      *
      * The order of records in the response is not guaranteed to match the ordering of records in the original job data.
      *
+     * @param {boolean} raw Get results as a CSV string
      * @returns Promise<IngestJobV2SuccessfulResults>
      */
-    getFailedResults(): Promise<IngestJobV2FailedResults<S>>;
+    getFailedResults(raw?: false): Promise<IngestJobV2FailedResults<S>>;
+    /** Return failed results
+     *
+     * The order of records in the response is not guaranteed to match the ordering of records in the original job data.
+     *
+     * @param {boolean} raw Get results as a CSV string
+     * @returns Promise<string>
+     */
+    getFailedResults(raw: true): Promise<string>;
     /** Return unprocessed results
      *
      * The unprocessed records endpoint returns records as a CSV.
      * If the request helper is able to parse it, you get the records
      * as an array of objects.
-     * If unable to parse the it (bad CSV), you get the raw response as a string.
+     * If unable to parse it (bad CSV), you get the raw response as a string.
      *
      * The order of records in the response is not guaranteed to match the ordering of records in the original job data.
      *
+     * @param {boolean} raw Get results as a CSV string
      * @returns Promise<IngestJobV2UnprocessedRecords>
      */
-    getUnprocessedRecords(): Promise<IngestJobV2UnprocessedRecords<S>>;
+    getUnprocessedRecords(raw?: false): Promise<IngestJobV2UnprocessedRecords<S>>;
+    /** Return unprocessed results
+   *
+   * The unprocessed records endpoint returns records as a CSV.
+   * If the request helper is able to parse it, you get the records
+   * as an array of objects.
+   * If unable to parse it (bad CSV), you get the raw response as a string.
+   *
+   * The order of records in the response is not guaranteed to match the ordering of records in the original job data.
+   *
+   * @param {boolean} raw Get results as a CSV string
+   * @returns Promise<string>
+   */
+    getUnprocessedRecords(raw: true): Promise<string>;
     /**
      * Deletes an ingest job.
      */

package/lib/api/bulk2.js

@@ -608,13 +608,17 @@ class IngestJobV2 extends events_1.EventEmitter {
         ]);
         return { successfulResults, failedResults, unprocessedRecords };
     }
-    /** Return successful results
-     *
-     * The order of records returned is not guaranteed to match the ordering of the uploaded data.
-     *
-     * @returns Promise<IngestJobV2SuccessfulResults>
-     */
-    async getSuccessfulResults() {
+    async getSuccessfulResults(raw) {
+        const reqOpts = {
+            method: 'GET',
+            path: `/${this.id}/successfulResults`,
+        };
+        if (raw) {
+            return this.createIngestRequest({
+                ...reqOpts,
+                responseType: 'text/plain',
+            });
+        }
         if (this.bulkJobSuccessfulResults) {
             return this.bulkJobSuccessfulResults;
         }
@@ -626,42 +630,43 @@ class IngestJobV2 extends events_1.EventEmitter {
         this.bulkJobSuccessfulResults = results ?? [];
         return this.bulkJobSuccessfulResults;
     }
-    /** Return failed results
-     *
-     * The order of records in the response is not guaranteed to match the ordering of records in the original job data.
-     *
-     * @returns Promise<IngestJobV2SuccessfulResults>
-     */
-    async getFailedResults() {
+    async getFailedResults(raw) {
+        const reqOpts = {
+            method: 'GET',
+            path: `/${this.id}/failedResults`,
+        };
+        if (raw) {
+            return this.createIngestRequest({
+                ...reqOpts,
+                responseType: 'text/plain',
+            });
+        }
         if (this.bulkJobFailedResults) {
             return this.bulkJobFailedResults;
         }
         const results = await this.createIngestRequest({
-            method: 'GET',
-            path: `/${this.id}/failedResults`,
+            ...reqOpts,
             responseType: 'text/csv',
         });
         this.bulkJobFailedResults = results ?? [];
         return this.bulkJobFailedResults;
     }
-    /** Return unprocessed results
-     *
-     * The unprocessed records endpoint returns records as a CSV.
-     * If the request helper is able to parse it, you get the records
-     * as an array of objects.
-     * If unable to parse the it (bad CSV), you get the raw response as a string.
-     *
-     * The order of records in the response is not guaranteed to match the ordering of records in the original job data.
-     *
-     * @returns Promise<IngestJobV2UnprocessedRecords>
-     */
-    async getUnprocessedRecords() {
+    async getUnprocessedRecords(raw) {
+        const reqOpts = {
+            method: 'GET',
+            path: `/${this.id}/unprocessedrecords`,
+        };
+        if (raw) {
+            return this.createIngestRequest({
+                ...reqOpts,
+                responseType: 'text/plain',
+            });
+        }
         if (this.bulkJobUnprocessedRecords) {
             return this.bulkJobUnprocessedRecords;
         }
         const results = await this.createIngestRequest({
-            method: 'GET',
-            path: `/${this.id}/unprocessedrecords`,
+            ...reqOpts,
             responseType: 'text/csv',
         });
         this.bulkJobUnprocessedRecords = results ?? [];

package/lib/oauth2.js

@@ -72,11 +72,11 @@ class OAuth2 {
                 revokeServiceUrl || `${this.loginUrl}/services/oauth2/revoke`;
         }
         else {
-            const loginUrlObject = new URL(loginUrl || defaultOAuth2Config.loginUrl);
-            this.loginUrl = loginUrlObject.href;
-            this.authzServiceUrl = `${loginUrlObject.origin}/services/oauth2/authorize`;
-            this.tokenServiceUrl = `${loginUrlObject.origin}/services/oauth2/token`;
-            this.revokeServiceUrl = `${loginUrlObject.origin}/services/oauth2/revoke`;
+            this.loginUrl = loginUrl ?? defaultOAuth2Config.loginUrl;
+            const maybeSlash = this.loginUrl.endsWith('/') ? '' : '/';
+            this.authzServiceUrl = `${this.loginUrl}${maybeSlash}services/oauth2/authorize`;
+            this.tokenServiceUrl = `${this.loginUrl}${maybeSlash}services/oauth2/token`;
+            this.revokeServiceUrl = `${this.loginUrl}${maybeSlash}services/oauth2/revoke`;
         }
         this.clientId = clientId;
         this.clientSecret = clientSecret;

package/lib/registry/sfdx.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SfdxRegistry = void 0;
 const child_process_1 = require("child_process");
-const strip_ansi_1 = __importDefault(require("strip-ansi"));
+const util_1 = require("util");
 const connection_1 = __importDefault(require("../connection"));
 function isNotNullOrUndefined(v) {
     return v != null;
@@ -38,7 +38,7 @@ class SfdxRegistry {
                 }
             });
         });
-        const body = (0, strip_ansi_1.default)(buf.toString());
+        const body = (0, util_1.stripVTControlCharacters)(buf.toString());
         let ret;
         try {
             ret = JSON.parse(body);

package/package.json

@@ -10,7 +10,7 @@
     "database.com"
   ],
   "homepage": "http://github.com/jsforce/jsforce",
-  "version": "3.5.2",
+  "version": "3.6.1",
   "repository": {
     "type": "git",
     "url": "git://github.com/jsforce/jsforce.git"
@@ -203,7 +203,6 @@
     "https-proxy-agent": "^5.0.0",
     "multistream": "^3.1.0",
     "node-fetch": "^2.6.1",
-    "strip-ansi": "^6.0.0",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {