google-spreadsheet 3.2.0 → 3.3.0

package/README.md

@@ -100,7 +100,7 @@ More info:
 
 ### Working with cells
 ```javascript
-await sheet.loadCells('A1:E10'); // loads a range of cells
+await sheet.loadCells('A1:E10'); // loads range of cells into local cache - DOES NOT RETURN THE CELLS
 console.log(sheet.cellStats); // total cells, loaded, how many non-empty
 const a1 = sheet.getCell(0, 0); // access cells using a zero-based index
 const c6 = sheet.getCellByA1('C6'); // or A1 style notation

package/lib/GoogleSpreadsheet.js

@@ -29,6 +29,7 @@ class GoogleSpreadsheet {
     this.authMode = null;
     this._rawSheets = {};
     this._rawProperties = null;
+    this._spreadsheetUrl = null;
 
     // create an axios instance with sheet root URL and interceptors to handle auth
     this.axios = Axios.create({
@@ -263,6 +264,7 @@ class GoogleSpreadsheet {
         ...includeCells && { includeGridData: true },
       },
     });
+    this._spreadsheetUrl = response.data.spreadsheetUrl;
     this._rawProperties = response.data.properties;
     _.each(response.data.sheets, (s) => this._updateOrCreateSheet(s));
   }
@@ -382,6 +384,43 @@ class GoogleSpreadsheet {
     const { sheets } = result.data;
     _.each(sheets, (sheet) => { this._updateOrCreateSheet(sheet); });
   }
+
+  // EXPORTING /////////////////////////////////////////////////////////////
+  async _downloadAs(fileType, worksheetId, returnStreamInsteadOfBuffer) {
+    // see https://stackoverflow.com/questions/11619805/using-the-google-drive-api-to-download-a-spreadsheet-in-csv-format/51235960#51235960
+
+    if (['html', 'xlsx', 'ods'].includes(fileType)) {
+      if (worksheetId) throw new Error(`Cannot specify worksheetId when exporting as ${fileType}`);
+    } else if (['csv', 'tsv', 'pdf'].includes(fileType)) {
+      if (worksheetId === undefined) throw new Error(`Must specify worksheetId when exporting as ${fileType}`);
+    } else {
+      throw new Error(`unsupported export fileType - ${fileType}`);
+    }
+
+    // google UI shows "html" but passes through "zip"
+    if (fileType === 'html') fileType = 'zip';
+
+    const exportUrl = this._spreadsheetUrl.replace('/edit', '/export');
+    const response = await this.axios.get(exportUrl, {
+      baseUrl: '', // unset baseUrl since we're not hitting the normal sheets API
+      params: {
+        id: this.spreadsheetId,
+        format: fileType,
+        ...worksheetId && { gid: worksheetId },
+      },
+      responseType: returnStreamInsteadOfBuffer ? 'stream' : 'arraybuffer',
+    });
+    return response.data;
+  }
+  async downloadAsHTML(returnStreamInsteadOfBuffer = false) {
+    return this._downloadAs('html', null, returnStreamInsteadOfBuffer);
+  }
+  async downloadAsXLSX(returnStreamInsteadOfBuffer = false) {
+    return this._downloadAs('xlsx', null, returnStreamInsteadOfBuffer);
+  }
+  async downloadAsODS(returnStreamInsteadOfBuffer = false) {
+    return this._downloadAs('ods', null, returnStreamInsteadOfBuffer);
+  }
 }
 
 module.exports = GoogleSpreadsheet;

package/lib/GoogleSpreadsheetWorksheet.js

@@ -444,6 +444,13 @@ class GoogleSpreadsheetWorksheet {
     return rows;
   }
 
+  async clearRows(options = {}) {
+    // default to first row after header
+    const startRowIndex = options.start || this._headerRowIndex + 1;
+    const endRowIndex = options.end || this.rowCount;
+    await this._spreadsheet.axios.post(`/values/${this.encodedA1SheetName}!${startRowIndex}:${endRowIndex}:clear`);
+  }
+
   // BASIC PROPS ///////////////////////////////////////////////////////////////////////////////////
   async updateProperties(properties) {
     // Request type = `updateSheetProperties`
@@ -626,9 +633,17 @@ class GoogleSpreadsheetWorksheet {
     // https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#DuplicateFilterViewRequest
   }
 
-  async duplicateSheet() {
+  async duplicate(options = {}) {
     // Request type = `duplicateSheet`
     // https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#DuplicateSheetRequest
+    const response = await this._makeSingleUpdateRequest('duplicateSheet', {
+      sourceSheetId: this.sheetId,
+      ...options.index !== undefined && { insertSheetIndex: options.index },
+      ...options.id && { newSheetId: options.id },
+      ...options.title && { newSheetName: options.title },
+    });
+    const newSheetId = response.properties.sheetId;
+    return this._spreadsheet.sheetsById[newSheetId];
   }
 
   async findReplace() {
@@ -850,12 +865,22 @@ class GoogleSpreadsheetWorksheet {
     });
   }
 
-  async clear() {
-    // clears all the data in the sheet
+  async clear(a1Range) {
+    // clears data in the sheet - defaults to entire sheet
+    const range = a1Range ? `!${a1Range}` : '';
     // sheet name without ie 'sheet1' rather than 'sheet1'!A1:B5 is all cells
-    await this._spreadsheet.axios.post(`/values/${this.encodedA1SheetName}:clear`);
+    await this._spreadsheet.axios.post(`/values/${this.encodedA1SheetName}${range}:clear`);
     this.resetLocalCache(true);
   }
+  async downloadAsCSV(returnStreamInsteadOfBuffer = false) {
+    return this._spreadsheet._downloadAs('csv', this.sheetId, returnStreamInsteadOfBuffer);
+  }
+  async downloadAsTSV(returnStreamInsteadOfBuffer = false) {
+    return this._spreadsheet._downloadAs('tsv', this.sheetId, returnStreamInsteadOfBuffer);
+  }
+  async downloadAsPDF(returnStreamInsteadOfBuffer = false) {
+    return this._spreadsheet._downloadAs('pdf', this.sheetId, returnStreamInsteadOfBuffer);
+  }
 }
 
 module.exports = GoogleSpreadsheetWorksheet;

package/package.json

@@ -2,7 +2,7 @@
   "author": "Theo Ephraim <theozero@gmail.com> (https://theoephraim.com)",
   "name": "google-spreadsheet",
   "description": "Google Sheets API (v4) -- simple interface to read/write data and manage sheets",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "license": "Unlicense",
   "keywords": [
     "google spreadsheets",
@@ -16,7 +16,7 @@
     "api",
     "googleapis"
   ],
-  "homepage": "https://github.com/theoephraim/node-google-spreadsheet",
+  "homepage": "https://theoephraim.github.io/node-google-spreadsheet",
   "repository": {
     "type": "git",
     "url": "git://github.com/theoephraim/node-google-spreadsheet.git"
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "delay": "^4.3.0",
-    "docsify-cli": "^4.4.0",
+    "docsify-cli": "^4.4.3",
     "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-plugin-async-await": "0.0.0",