@yuanqing/google-sheets/src/sheet/sheet.js

An easier interface to read from and write to Google Sheets

class Sheet {
  constructor (
    request,
    spreadsheetId,
    sheetId,
    sheetName,
    headers,
    columnRange
  ) {
    this.request = request
    this.spreadsheetId = spreadsheetId
    this.sheetId = sheetId
    this.sheetName = sheetName
    this.headers = headers
    this.columnRange = columnRange
  }

  async getAllRows () {
    // https://developers.google.com/sheets/api/samples/reading#read_a_single_range
    const queryParameters = [
      `ranges=${this.sheetName}!${this.columnRange.start}:${
        this.columnRange.end
      }`,
      'majorDimension=ROWS',
      'valueRenderOption=UNFORMATTED_VALUE'
    ]
    const json = await this.request(
      'GET',
      `${this.spreadsheetId}/values:batchGet?${queryParameters.join('&')}`
    )
    return this.mapArrayToObject(json.valueRanges[0].values).slice(1)
  }

  async getRowsByRange (startIndex, endIndex) {
    // https://developers.google.com/sheets/api/samples/reading#read_a_single_range
    const queryParameters = [
      `ranges=${this.sheetName}!${startIndex}:${endIndex}`,
      'majorDimension=ROWS',
      'valueRenderOption=UNFORMATTED_VALUE'
    ]
    const json = await this.request(
      'GET',
      `${this.spreadsheetId}/values:batchGet?${queryParameters.join('&')}`
    )
    return this.mapArrayToObject(json.valueRanges[0].values)
  }

  async addRows (rows) {
    const range = `${this.sheetName}!${this.columnRange.start}:${
      this.columnRange.end
    }`
    // https://developers.google.com/sheets/api/samples/writing#append_values
    await this.request(
      'POST',
      `${
        this.spreadsheetId
      }/values/${range}:append?valueInputOption=USER_ENTERED`,
      {
        range,
        majorDimension: 'ROWS',
        values: this.mapObjectToArray(rows)
      }
    )
    return Promise.resolve(rows)
  }

  async deleteSheet () {
    // https://developers.google.com/sheets/api/samples/sheet#delete_a_sheet
    return this.request('POST', `${this.spreadsheetId}:batchUpdate`, {
      requests: [
        {
          deleteSheet: {
            sheetId: this.sheetId
          }
        }
      ]
    })
  }

  mapArrayToObject (arrays) {
    const headers = this.headers
    return arrays.map(function (array) {
      const object = {}
      headers.forEach(function (header, index) {
        if (!header || header.length === 0) {
          return
        }
        object[header] = array[index]
      })
      return object
    })
  }

  mapObjectToArray (objects) {
    const headers = this.headers
    return objects.map(function (object) {
      return headers.map(function (header) {
        return object[header] || ''
      })
    })
  }
}

module.exports = Sheet