Version 8.0.1-v2.1-24.2.00.00 release

Author: root

CHANGELOG.md

@@ -2,6 +2,11 @@
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
 
+## [v8.0.1] - eSignature API v2.1-24.2.00.00 - 2024-08-22
+### Changed
+- Fixed issue with document downloads when `Content-Transfer-Encoding` is set to `base64`.
+- Updated the SDK release version.
+
 ## [v8.0.0] - eSignature API v2.1-24.2.00.00 - 2024-07-25
 ### Breaking Changes
 

README.md

@@ -32,7 +32,7 @@ This client SDK is provided as open source, which enables you to customize its f
 <a id="versionInformation"></a>
 ### Version Information
 - **API version**: v2.1
-- **Latest SDK version**: 8.0.0
+- **Latest SDK version**: 8.0.1
 
 <a id="requirements"></a>
 ## Requirements

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusign-esign",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "description": "Docusign Node.js API client.",
   "license": "MIT",
   "main": "src/index.js",

src/ApiClient.js

@@ -185,7 +185,7 @@
     this.defaultHeaders = {
       "X-DocuSign-SDK": "Node",
       "Node-Ver": process.version,
-      "User-Agent": `Swagger-Codegen/v2.1/8.0.0/node/${process.version}`,
+      "User-Agent": `Swagger-Codegen/v2.1/8.0.1/node/${process.version}`,
     };  
 
     opts = {...defaults, ...opts};
@@ -704,13 +704,19 @@
         request
           .then((response) => {
             try {
-              const streamData = [];
+              let streamData = [];
               if (requestConfig.headers["Accept"] === "application/pdf") {
                 response.data.on("data", (chunk) => {
-                  streamData.push(chunk);
+                  streamData.push(requestConfig.headers["Content-Transfer-Encoding"] === "base64" ? chunk.toString() : chunk);
                 });
                 response.data.on("end", () => {
-                  resolve(Buffer.concat(streamData));
+                  let res = '';
+                  if(!!streamData.length && streamData[0] instanceof Uint8Array) {
+                    res = Buffer.concat(streamData);
+                  } else {
+                    res = streamData.join('');
+                  }
+                  resolve(res);
                 });
               } else {
                 data = _this.deserialize(response, returnType);
@@ -728,13 +734,19 @@
       request
         .then((response) => {
           try {
-            const streamData = [];
+            let streamData = [];
             if (requestConfig.headers["Accept"] === "application/pdf") {
               response.data.on("data", (chunk) => {
-                streamData.push(chunk);
+                streamData.push(requestConfig.headers["Content-Transfer-Encoding"] === "base64" ? chunk.toString() : chunk);
               });
               response.data.on("end", () => {
-                callback(null, Buffer.concat(streamData), response);
+                let res = '';
+                if(!!streamData.length && streamData[0] instanceof Uint8Array) {
+                  res = Buffer.concat(streamData);
+                } else {
+                  res = streamData.join('');
+                }
+                callback(null, res, response);
               });
             } else {
               data = _this.deserialize(response, returnType);

test/SdkUnitTests.js

@@ -733,15 +733,17 @@ describe('SDK Unit Tests:', function (done) {
       .then(function (envelopeSummary) {
         if (envelopeSummary) {
           console.log('EnvelopeSummary: ' + JSON.stringify(envelopeSummary));
+          apiClient.addDefaultHeader('Content-Transfer-Encoding', 'base64');
           envelopesApi.getDocument(accountId, envelopeSummary.envelopeId, 'combined')
             .then(function (pdfBytes) {
+              apiClient.addDefaultHeader('Content-Transfer-Encoding', undefined);
               if (pdfBytes) {
                 try {
                   var fs = require('fs');
                   // download the document pdf
                   var filename = accountId + '_' + envelopeSummary.envelopeId + '_combined.pdf';
                   var tempFile = path.resolve(__dirname, filename);
-                  fs.writeFile(tempFile, Buffer.from(pdfBytes, 'binary'), function (err) {
+                  fs.writeFile(tempFile, pdfBytes, 'base64', function (err) {
                     if (err) console.log('Error: ' + err);
                     ValidatePdf(tempFile).then(() => {
                       done();

test/SdkUnitTestsWithCallback.js

@@ -589,7 +589,9 @@ describe('SDK Unit Tests With Callbacks:', function (done) {
 
       if (envelopeSummary) {
         console.log('EnvelopeSummary: ' + JSON.stringify(envelopeSummary));
+        apiClient.addDefaultHeader('Content-Transfer-Encoding', 'base64');
         envelopesApi.getDocument(accountId, envelopeSummary.envelopeId, 'combined', function (err, pdfBytes, response) {
+          apiClient.addDefaultHeader('Content-Transfer-Encoding', undefined);
           if (err) {
             return done(err);
           }
@@ -600,7 +602,7 @@ describe('SDK Unit Tests With Callbacks:', function (done) {
               // download the document pdf
               var filename = accountId + '_' + envelopeSummary.envelopeId + '_combined.pdf';
               var tempFile = path.resolve(__dirname, filename);
-              fs.writeFile(tempFile, Buffer.from(pdfBytes, 'binary'), function (err) {
+              fs.writeFile(tempFile, pdfBytes, 'base64', function (err) {
                 if (err) console.log('Error: ' + err);
                 ValidatePdf(tempFile).then(() => {
                   done();