Migration from Sheets API v3 to v4 -- in progress

Author: ajitesh-NC

lib/sheets.js

@@ -1,6 +1,7 @@
 "use strict";
 const { google } = require('googleapis');
 var Promise = require('polyfill-promise');
+var excelColumnName = require('excel-column-name');
 
 /**
  * Authorizationn via GoogleApis
@@ -96,6 +97,8 @@ Sheets.prototype.getSheets = async function getSheets(docId) {
       spreadsheetId: docId
     }
     const response = await sheets.spreadsheets.get(request);
+    
+    console.log('v4 response-->', response.data.sheets )
     return(response.data.sheets.map((sheet) => {
       return {
         id: sheet.properties.sheetId,
@@ -118,6 +121,7 @@ Sheets.prototype.getSheets = async function getSheets(docId) {
 Sheets.prototype.getSheet = async function getSheet(docId, sheetId) {
   try {
     const sheetsInfo = await this.getSheets(docId);
+    console.log('-----sheetsInfo-----', sheetsInfo)
     const { id, title, rowCount, colCount } = sheetsInfo
     .find((sheet) => sheet.id === +sheetId);
 
@@ -149,6 +153,7 @@ Sheets.prototype.getList = async function getList(docId, sheetId) {
       range: title
     }
     const sheet = await sheets.spreadsheets.values.get(request);
+    // console.log(JSON.stringify(sheet.data.values, null, 2));
     return sheet.data.values;
   } catch(error) {
     throw new Error(error);
@@ -164,12 +169,132 @@ Sheets.prototype.getList = async function getList(docId, sheetId) {
 Sheets.prototype.getCells = async function getCells(docId, sheetId) {
   try {
     const cells = await this.getRange(docId, sheetId);
-    return cells.flat();
+    return cells.flat().filter(cell => cell.content != '');
   } catch (e) {
     throw new Error(e);
   }
 };
 
+
+/**
+ * Convert rangeInfo to valid Google Sheets API v4 range
+ *
+ * Examples:
+ *
+ * - "Sheet1!A1:B2" refers to the first two cells in the top two rows of Sheet1.
+ * - "Sheet1!A:A" refers to all the cells in the first column of Sheet1.
+ * - "Sheet1!1:2" refers to all the cells in the first two rows of Sheet1.
+ * - "Sheet1!A5:A" refers to all the cells of the first column of Sheet 1, from row 5 onward.
+ * - "Sheet1" refers to all the cells in Sheet1.
+ * - "'My Custom Sheet'!A:A" refers to all the cells in a sheet named "My Custom Sheet."
+ *   Single quotes are required for sheet names with spaces, special characters, or an alphanumeric combination.
+ *
+ * @param {String} t Title, name of the sheet
+ * @param {String} ri Range info, e.g "A1:B2", where "A" and "B" are columns and "1" and "2" are rows
+ */
+Sheets.prototype.toV4Range = (t, ri) => {
+  // Titles with spaces need to be wrapped into single quotes
+  let title = t.includes(" ") ? `'${t}'` : t;
+
+  // Return just the title "Sheet1" if there is no range info
+  if ([undefined, null].includes(ri)) {
+    return title;
+  }
+
+  // "Sheet1!A3:" -> "Sheet1" -> start from A3 and go column per column on the response returning all cells that are on row 3 or above
+  if (ri[ri.length - 1] === ":") {
+    return title;
+  }
+  // "Sheet1!1:2" -> all the cells in the first two rows of Sheet1
+  // const patternMatch = ri.match(/([a-zA-Z]*)(\d*):([a-zA-Z]*)(\d*)/);
+  // if (patternMatch && patternMatch[1] === '' && patternMatch[3] === '') {
+  //   return title;
+  // }
+
+  return `${title}!${ri}`;
+  // return title;
+};
+
+
+ Sheets.prototype.fullDataMatrix = function (data, range) {
+  const parts = range//'D1:D5'//'C5:A1'//'A1:B2'//'A1:C5'//'B2:C2';
+  const partsMatch = parts.match(/([a-zA-Z]*)(\d*):([a-zA-Z]*)(\d*)/);
+  let noOfColumns = 0;
+  let startCol = 0;
+  let noOfRows = 0;
+  let startRow = 0;
+
+  // No column specified --> '1:2'
+  if(partsMatch[1] === '' && partsMatch[3] === ''){
+    let col = 0;
+    
+    for (let r = 0; r < data.length; r += 1) {
+      for (let c = 0; c < data[r].length; c += 1) {
+        if (c >= col) {
+          col = col + c;
+        }
+      }
+    }
+    noOfRows = Math.abs(+partsMatch[4] - +partsMatch[2]) + 1;
+    startRow = Math.min(+partsMatch[2], +partsMatch[4]);
+    noOfColumns = col;
+    startCol = 1;
+  } 
+  // No row specified --> 'A:B' OR 'A:A' OR 'B:B'
+  else if (partsMatch[2] === '' && partsMatch[4] === '') {
+    noOfRows = data.length;
+    startRow = 1;
+    noOfColumns = Math.abs(
+      excelColumnName.excelColToInt(partsMatch[3]) - excelColumnName.excelColToInt(partsMatch[1])
+    ) + 1;
+    startCol = Math.min(excelColumnName.excelColToInt(partsMatch[1]), excelColumnName.excelColToInt(partsMatch[3]))
+  }
+  // Only 1st part of a range specified --> 'A3:'
+  else if (partsMatch[3] === '' && partsMatch[4] === '') {
+    let col = 0;
+    
+    for (let r = 0; r < data.length; r += 1) {
+      for (let c = 0; c < data[r].length; c += 1) {
+        if (c >= col) {
+          col = col + c;
+        }
+      }
+    }
+    startRow = +partsMatch[2];
+    noOfRows = Math.abs(data.length - startRow) + 1;
+    startCol = excelColumnName.excelColToInt(partsMatch[1]);
+    noOfColumns = Math.abs(col - startCol) + 1;
+
+    console.log('results-->', startRow, startCol, noOfRows, noOfColumns, partsMatch[1], excelColumnName.excelColToInt(partsMatch[1]))
+  } 
+  // full range specified --> 'A1:C5'
+  else {
+    noOfRows = Math.abs(+partsMatch[4] - +partsMatch[2]) + 1;
+    startRow = Math.min(+partsMatch[2], +partsMatch[4]);
+    noOfColumns = Math.abs(
+      excelColumnName.excelColToInt(partsMatch[3]) - excelColumnName.excelColToInt(partsMatch[1])
+    ) + 1;
+    startCol = Math.min(excelColumnName.excelColToInt(partsMatch[1]), excelColumnName.excelColToInt(partsMatch[3]))
+  }
+
+  const nMatrix = [...Array(noOfRows)]
+    .map((_ ,r) =>
+      [...Array(noOfColumns)]
+        .map((__, c) => ({ row: r+startRow, col: c+startCol, content: '' }))
+    )
+  console.log('nMatrix', nMatrix)
+  for (let r = 0; r < nMatrix.length; r += 1) {
+    for (let c = 0; c < nMatrix[r].length; c += 1) {
+      // console.log('data--->', r, c, data[r+startRow-1][c+startCol-1], nMatrix[r][c])
+      // const startRowIndex = startRow - 1;
+      // const startColIndex = startCol - 1;
+      // console.log('results-->', startRow, startCol, data[r+startRowIndex][c+startColIndex])
+      nMatrix[r][c].content = (data  === undefined || data[r][c] === undefined) ? '' : data[r][c];
+    }
+  }
+  return nMatrix;
+}
+
 /**
  * Retrieve cells based on given range
  * NOTE: If there are missing cells (no content) this function
@@ -179,33 +304,83 @@ Sheets.prototype.getCells = async function getCells(docId, sheetId) {
  * @param  {String} docId     Sheet document id
  * @param  {String} sheetId   Sheet id
  * @param  {Mixed}  rangeInfo Range info. use sheets A1 notation for this https://developers.google.com/sheets/api/guides/concepts
- * @return {Promise}          Rows containing cells, like [[{A1}, {B1}], [{A2}, {B2}]]
+ * @return {Promise<{ row: Number, column: String, content: String }[]>}          Rows containing cells, like [[{A1}, {B1}], [{A2}, {B2}]]
  */
 Sheets.prototype.getRange = async function(docId, sheetId, rangeInfo) {
   try {
     const [{ title }, sheets] = await Promise.all([
       this.getSheet(docId, sheetId),
       this.get()
     ]);
-
+    const range = this.toV4Range(title, rangeInfo);
     const request = {
       spreadsheetId: docId,
-      range: rangeInfo === undefined ? title : `${title}!${rangeInfo}`,
+      range
     }
     const sheet = await sheets.spreadsheets.values.get(request);
-    return sheet.data.values.map((row, index) => {
-      const rowIndex = index + 1;
-      return row.map((cell, cellIndex) => {
-        return {
-          row: rowIndex,
-          column: this.columnLetters.split(',')[cellIndex],
-          content: cell
-        };
-      });
-    });
+    console.log('Actual data-->', sheet.data.values)
+    return this.fullDataMatrix(sheet.data.values, rangeInfo);
+    // const patternMatch = ![undefined, null].includes(rangeInfo) 
+    //             ? rangeInfo.match(/([a-zA-Z]*)(\d*):([a-zA-Z]*)(\d*)/)
+    //             : null
+    // const sheet = await sheets.spreadsheets.values.get(request);
+    // console.log('Actual data-->', sheet.data.values)
+    // const fullMatrix = this.fullDataMatrix(sheet.data.values);
+    
+    // if(patternMatch && patternMatch[1] === '' && patternMatch[3] === ''){ // range 'Sheet1!1:2'
+    //   return fullMatrix.slice(patternMatch[2] - 1, patternMatch[4]);
+    // } else if (patternMatch && patternMatch[3] === '' && patternMatch[4] === '') { // range 'Sheet1!A3:'
+    //   return fullMatrix.slice(patternMatch[2] - 1, fullMatrix.length);
+    // } 
+    // else { // range "Sheet1"
+    //   return fullMatrix;
+    // }
+    
   } catch(error) {
     throw new Error(error);
   }
 };
 
+/**
+ * Parse given range from given string, like 'A2:C8' or 'A2:'
+ * @param  {String} str Range info
+ * @return {Object}     Range info { from: { col: 'A', row: 2 }, to: ...}
+ */
+ Sheets.prototype.parseRangeInfo = function (str) {
+  var rangeInfo = {
+    from: {
+      col: null,
+      row: null,
+    },
+    to: {
+      col: null,
+      row: null,
+    },
+  };
+
+  // Match full range: A1:B20
+  var match = str.match(/([a-zA-Z]+)(\d+):([a-zA-Z]+)(\d+)/);
+
+  if (match && match.length > 1) {
+    rangeInfo.from.row = parseInt(match[2], 10);
+    rangeInfo.from.col = match[1];
+    rangeInfo.to.row = parseInt(match[4], 10);
+    rangeInfo.to.col = match[3];
+
+    return rangeInfo;
+  }
+
+  // Match full range: A1:
+  var match = str.match(/(\w)(\d+):/);
+  if (match && match.length > 1) {
+    rangeInfo.from.row = parseInt(match[2], 10);
+    rangeInfo.from.col = match[1];
+
+    return rangeInfo;
+  }
+
+  return rangeInfo;
+};
+
+
 module.exports = Sheets;

package-lock.json

@@ -24,6 +24,7 @@
     "url": "https://github.com/SC5/google-sheets-api/issues"
   },
   "dependencies": {
+    "excel-column-name": "^1.0.1",
     "googleapis": "^59.0.0",
     "lodash": "^4.17.20",
     "polyfill-promise": "^4.0.0",

package.json

@@ -1,67 +1,7 @@
 [
-  {
-    "row": "1",
-    "column": "A",
-    "content": "A1"
-  },
-  {
-    "row": "1",
-    "column": "B",
-    "content": "B1"
-  },
-  {
-    "row": "1",
-    "column": "C",
-    "content": "C1"
-  },
-  {
-    "row": "2",
-    "column": "A",
-    "content": "A2"
-  },
-  {
-    "row": "2",
-    "column": "C",
-    "content": "C2"
-  },
-  {
-    "row": "3",
-    "column": "A",
-    "content": "A3"
-  },
-  {
-    "row": "4",
-    "column": "A",
-    "content": "A4"
-  },
-  {
-    "row": "5",
-    "column": "A",
-    "content": "A5"
-  },
-  {
-    "row": "6",
-    "column": "A",
-    "content": "A5"
-  },
-  {
-    "row": "7",
-    "column": "A",
-    "content": "A7"
-  },
-  {
-    "row": "8",
-    "column": "A",
-    "content": "A8"
-  },
-  {
-    "row": "9",
-    "column": "A",
-    "content": "A9"
-  },
-  {
-    "row": "10",
-    "column": "A",
-    "content": "A10"
-  }
+  ["A1", "B1", "C1"],
+  ["A2", "B2", "C2"],
+  ["A3", "B3", "C3"],
+  ["A4", "B4", "C4"],
+  ["A5", "B5", "C5"]
 ]

spec/cells.json

@@ -0,0 +1,11 @@
+{
+    "data": {
+      "range": "B1:C2",
+      "majorDimension": "ROWS",
+      "values": [
+        ["B1", "C1"],
+        ["", "C2"]
+      ]
+    }
+  }
+  

spec/range-of-values-1.json

@@ -0,0 +1,16 @@
+{
+    "data": {
+      "range": "A3:A",
+      "majorDimension": "ROWS",
+      "values": [
+        [ "A3" ],
+        [ "A4" ],
+        [ "A5" ],
+        [ "A5" ],
+        [ "A7" ],
+        [ "A8" ],
+        [ "A9" ],
+        [ "A10" ]
+      ]
+    }
+}