google-spreadsheet 3.3.0 → 4.0.1

package/src/lib/lodash.ts

@@ -0,0 +1,32 @@
+// re-export just what we need from lodash
+// we do this so we can use a single import, but hopefully
+// it helps keep bundle sizes down in front-end projects using this lib
+
+export { default as compact } from 'lodash/compact';
+
+export { default as each } from 'lodash/each';
+export { default as filter } from 'lodash/filter';
+export { default as find } from 'lodash/find';
+export { default as flatten } from 'lodash/flatten';
+export { default as get } from 'lodash/get';
+export { default as groupBy } from 'lodash/groupBy';
+export { default as isArray } from 'lodash/isArray';
+export { default as isBoolean } from 'lodash/isBoolean';
+export { default as isEqual } from 'lodash/isEqual';
+export { default as isFinite } from 'lodash/isFinite';
+export { default as isInteger } from 'lodash/isInteger';
+export { default as isNil } from 'lodash/isNil';
+export { default as isNumber } from 'lodash/isNumber';
+export { default as isObject } from 'lodash/isObject';
+export { default as isString } from 'lodash/isString';
+export { default as keyBy } from 'lodash/keyBy';
+export { default as keys } from 'lodash/keys';
+export { default as map } from 'lodash/map';
+export { default as omit } from 'lodash/omit';
+export { default as pickBy } from 'lodash/pickBy';
+export { default as set } from 'lodash/set';
+export { default as some } from 'lodash/some';
+export { default as sortBy } from 'lodash/sortBy';
+export { default as times } from 'lodash/times';
+export { default as unset } from 'lodash/unset';
+export { default as values } from 'lodash/values';

package/src/lib/types/auth-types.ts

@@ -0,0 +1,18 @@
+// optional peer dependency - this ts-ignore should help when user is not using it
+// @ts-ignore
+import type { Headers } from 'google-auth-library/build/src/auth/oauth2client';
+
+/** single type to handle all valid auth types */
+export type GoogleApiAuth =
+  // this simple interface should cover all google-auth-library auth methods
+  | { getRequestHeaders: () => Promise<Headers> }
+  // used to pass in an API key only
+  | { apiKey: string }
+  // used to pass in a raw token
+  | { token: string };
+
+export enum AUTH_MODES {
+  GOOGLE_AUTH_CLIENT = 'google_auth',
+  RAW_ACCESS_TOKEN = 'raw_access_token',
+  API_KEY = 'api_key'
+}

package/src/lib/types/drive-types.ts

@@ -0,0 +1,40 @@
+
+export type PermissionRoles =
+  'owner' |
+  'writer' |
+  'commenter' |
+  'reader';
+  // these roles also exist but are not needed for our use case
+  // 'organizer' | 'fileOrganizer'
+
+export type PublicPermissionRoles = Exclude<PermissionRoles, 'owner'>;
+
+// this shape is set by what we request...
+type PublicPermissionListEntry = {
+  id: 'anyoneWithLink'
+  type: 'anyone',
+  role: PublicPermissionRoles,
+};
+type UserOrGroupPermissionListEntry = {
+  id: string;
+  displayName: string;
+  type: 'user' | 'group';
+  photoLink?: string;
+  emailAddress: string;
+  role: PermissionRoles;
+  deleted: boolean;
+};
+type DomainPermissionListEntry = {
+  id: string;
+  displayName: string;
+  type: 'domain';
+  domain: string;
+  role: PublicPermissionRoles;
+  photoLink?: string;
+};
+
+export type PermissionsList = (
+  PublicPermissionListEntry |
+  UserOrGroupPermissionListEntry |
+  DomainPermissionListEntry
+)[];

package/src/lib/types/sheets-types.ts

@@ -0,0 +1,528 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+import { MakeOptional } from './util-types';
+
+// some basic types which are just aliases, but they make the code a bit clearer
+export type Integer = number;
+
+export type SpreadsheetId = string;
+export type WorksheetId = number;
+export type DataSourceId = string;
+
+export type WorksheetIndex = number;
+export type RowOrColumnIndex = number;
+export type RowIndex = number;
+export type ColumnIndex = number;
+export type A1Address = string;
+export type ColumnAddress = string;
+export type A1Range = string;
+
+export type NamedRangeId = string;
+
+
+
+/**
+ * ISO language code
+ * @example en
+ * @example en_US
+ * */
+export type LocaleCode = string;
+/**
+ * timezone code, if not recognized, may be a custom time zone such as `GMT-07:00`
+ * @example America/New_York
+ * */
+export type Timezone = string;
+
+// ENUMS ///////////////////////////////////////////////////////////////////////////////////////////////////
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#SheetType */
+export type WorksheetType =
+  /** The sheet is a grid. */
+  'GRID' |
+  /** The sheet has no grid and instead has an object like a chart or image. */
+  'OBJECT' |
+  /** The sheet connects with an external DataSource and shows the preview of data. */
+  'DATA_SOURCE';
+
+export type WorksheetDimension = 'ROWS' | 'COLUMNS';
+
+export type HyperlinkDisplayType = 'LINKED' | 'PLAIN_TEXT';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#numberformattype */
+export type NumberFormatType =
+  /** Text formatting, e.g 1000.12 */
+  'TEXT' |
+  /** Number formatting, e.g, 1,000.12 */
+  'NUMBER' |
+  /** Percent formatting, e.g 10.12% */
+  'PERCENT' |
+  /** Currency formatting, e.g $1,000.12 */
+  'CURRENCY' |
+  /** Date formatting, e.g 9/26/2008 */
+  'DATE' |
+  /** Time formatting, e.g 3:59:00 PM */
+  'TIME' |
+  /** Date+Time formatting, e.g 9/26/08 15:59:00 */
+  'DATE_TIME' |
+  /** Scientific number formatting, e.g 1.01E+03 */
+  'SCIENTIFIC';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#errortype */
+export type CellValueErrorType =
+  /** Corresponds to the #ERROR! error */
+  'ERROR' |
+  /** Corresponds to the #NULL! error. */
+  'NULL_VALUE' |
+  /** Corresponds to the #DIV/0 error. */
+  'DIVIDE_BY_ZERO' |
+  /** Corresponds to the #VALUE! error. */
+  'VALUE' |
+  /** Corresponds to the #REF! error. */
+  'REF' |
+  /** Corresponds to the #NAME? error. */
+  'NAME' |
+  /** Corresponds to the #NUM! error. */
+  'NUM' |
+  /** Corresponds to the #N/A error. */
+  'N_A' |
+  /** Corresponds to the Loading... state. */
+  'LOADING';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#horizontalalign */
+export type HorizontalAlign = 'LEFT' | 'CENTER' | 'RIGHT';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#verticalalign */
+export type VerticalAlign = 'TOP' | 'MIDDLE' | 'BOTTOM';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#textdirection */
+export type TextDirection = 'LEFT_TO_RIGHT' | 'RIGHT_TO_LEFT';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#wrapstrategy */
+export type WrapStrategy = 'OVERFLOW_CELL' | 'LEGACY_WRAP' | 'CLIP' | 'WRAP';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#themecolortype */
+export type ThemeColorType = 'TEXT' | 'BACKGROUND' | 'ACCENT1' | 'ACCENT2' | 'ACCENT3' | 'ACCENT4' | 'ACCENT5' | 'ACCENT6' | 'LINK';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#recalculationinterval */
+export type RecalculationInterval = 'ON_CHANGE' | 'MINUTE' | 'HOUR';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata#developermetadatavisibility */
+export type DeveloperMetadataVisibility =
+  /** Document-visible metadata is accessible from any developer project with access to the document. */
+  | 'DOCUMENT'
+  /** Project-visible metadata is only visible to and accessible by the developer project that created the metadata. */
+  | 'PROJECT';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata#developermetadatalocationtype */
+export type DeveloperMetadataLocationType = 'ROW' | 'COLUMN' | 'SHEET' | 'SPREADSHEET';
+
+
+
+// formatting types
+export type TextFormat = {
+  foregroundColor?: Color;
+  foregroundColorStyle?: ColorStyle;
+  fontFamily?: string;
+  fontSize?: number;
+  bold?: boolean;
+  italic?: boolean;
+  strikethrough?: boolean;
+  underline?: boolean;
+};
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#Style */
+export type CellBorderLineStyle = 'NONE' | 'DOTTED' | 'DASHED' | 'SOLID' | 'SOLID_MEDIUM' | 'SOLID_THICK' | 'DOUBLE';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#Border */
+export type CellBorder = {
+  style: CellBorderLineStyle;
+  width: number;
+  color: Color;
+  colorStyle: ColorStyle;
+};
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#Borders */
+export type CellBorders = {
+  top: CellBorder;
+  bottom: CellBorder;
+  left: CellBorder;
+  right: CellBorder;
+};
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#Padding */
+export type CellPadding = {
+  top: number;
+  bottom: number;
+  left: number;
+  right: number;
+};
+
+export type TextRotation = {
+  angle: number;
+  vertical: boolean;
+};
+
+export type ThemeColorPair = {
+  color: ColorStyle;
+  colorType: ThemeColorType;
+};
+
+export type SpreadsheetTheme = {
+  primaryFontFamily: string;
+  themeColors: ThemeColorPair[];
+};
+
+// ---------------------------------
+
+export type PaginationOptions = {
+  limit: number;
+  offset: number;
+};
+
+/**
+ * @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#iterativecalculationsettings
+ */
+export type IterativeCalculationSetting = {
+  maxIterations: number;
+  convergenceThreshold: number;
+};
+
+
+export type DimensionRangeIndexes = {
+  startIndex: RowOrColumnIndex;
+  endIndex: RowOrColumnIndex;
+};
+
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata#DeveloperMetadata.DeveloperMetadataLocation */
+export interface DeveloperMetadataLocation {
+  sheetId: number;
+  spreadsheet: boolean;
+  dimensionRange: DimensionRange;
+  locationType: DeveloperMetadataLocationType;
+}
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata#DeveloperMetadata.DeveloperMetadataLocation */
+export interface DeveloperMetadata {
+  metadataId: number;
+  metadataKey: string;
+  metadataValue: string;
+  location: DeveloperMetadataLocation;
+  visibility: DeveloperMetadataVisibility;
+}
+
+export interface WorksheetDimensionProperties {
+  pixelSize: number;
+  hiddenByUser: boolean;
+  hiddenByFilter: boolean;
+
+  /**
+   * @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata#DeveloperMetadata
+   */
+  developerMetadata: DeveloperMetadata[];
+}
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#DataSourceColumnReference */
+type DataSourceColumnReference = {
+  name: string;
+};
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#DataSourceColumn */
+type DataSourceColumn = {
+  reference: DataSourceColumnReference,
+  formula: string
+};
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#DataExecutionState */
+type DataExecutionState =
+  /** The data execution has not started. */
+  'NOT_STARTED' |
+  /** The data execution has started and is running. */
+  'RUNNING' |
+  /** The data execution has completed successfully. */
+  'SUCCEEDED' |
+  /** The data execution has completed with errors. */
+  'FAILED';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#DataExecutionState */
+type DataExecutionErrorCode =
+  /** Default value, do not use. */
+  'DATA_EXECUTION_ERROR_CODE_UNSPECIFIED' |
+  /** The data execution timed out. */
+  'TIMED_OUT' |
+  /** The data execution returns more rows than the limit. */
+  'TOO_MANY_ROWS' |
+  /** The data execution returns more columns than the limit. */
+  'TOO_MANY_COLUMNS' |
+  /** The data execution returns more cells than the limit. */
+  'TOO_MANY_CELLS' |
+  /** Error is received from the backend data execution engine (e.g. BigQuery). Check errorMessage for details. */
+  'ENGINE' |
+  /** One or some of the provided data source parameters are invalid. */
+  'PARAMETER_INVALID' |
+  /** The data execution returns an unsupported data type. */
+  'UNSUPPORTED_DATA_TYPE' |
+  /** The data execution returns duplicate column names or aliases. */
+  'DUPLICATE_COLUMN_NAMES' |
+  /** The data execution is interrupted. Please refresh later. */
+  'INTERRUPTED' |
+  /** The data execution is currently in progress, can not be refreshed until it completes. */
+  'CONCURRENT_QUERY' |
+  /** Other errors. */
+  'OTHER' |
+  /** The data execution returns values that exceed the maximum characters allowed in a single cell. */
+  'TOO_MANY_CHARS_PER_CELL' |
+  /** The database referenced by the data source is not found. */
+  'DATA_NOT_FOUND' |
+  /** The user does not have access to the database referenced by the data source. */
+  'PERMISSION_DENIED' |
+  /** The data execution returns columns with missing aliases. */
+  'MISSING_COLUMN_ALIAS' |
+  /** The data source object does not exist. */
+  'OBJECT_NOT_FOUND' |
+  /** The data source object is currently in error state. To force refresh, set force in RefreshDataSourceRequest . */
+  'OBJECT_IN_ERROR_STATE' |
+  /** The data source object specification is invalid. */
+  'OBJECT_SPEC_INVALID';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#DataExecutionStatus */
+type DataExecutionStatus = {
+  'state': DataExecutionState,
+  'errorCode': DataExecutionErrorCode,
+  'errorMessage': string,
+  'lastRefreshTime': string
+};
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#DataSourceSheetProperties */
+export type DataSourceSheetProperties = {
+  'dataSourceId': DataSourceId
+  'columns': DataSourceColumn[],
+  'dataExecutionStatus': DataExecutionStatus,
+};
+
+
+// Spreadsheet types /////////////////////
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#SpreadsheetProperties */
+export type SpreadsheetProperties = {
+  /** title of the spreadsheet */
+  title: string,
+  /** locale of the spreadsheet (note - not all locales are supported) */
+  locale: LocaleCode,
+  /** amount of time to wait before volatile functions are recalculated */
+  autoRecalc: RecalculationInterval,
+  /** timezone of the sheet */
+  timeZone: Timezone;
+
+  // TODO
+  defaultFormat: any
+  iterativeCalculationSettings: any,
+  spreadsheetTheme: any
+};
+
+
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#SheetProperties */
+export type WorksheetProperties = {
+  'sheetId': WorksheetId,
+  'title': string,
+  'index': WorksheetIndex,
+  'sheetType': WorksheetType,
+  'gridProperties': WorksheetGridProperties,
+  'hidden': boolean,
+  'tabColor': Color,
+  'tabColorStyle': ColorStyle,
+  'rightToLeft': boolean,
+  'dataSourceSheetProperties': DataSourceSheetProperties
+};
+export type WorksheetPropertiesPartial = {
+
+};
+
+// Spreadsheet Cell types ///////////////////
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#CellFormat */
+export type CellFormat = {
+  /** format describing how number values should be represented to the user */
+  numberFormat: NumberFormat,
+  /** @deprecated use backgroundColorStyle */
+  backgroundColor: Color,
+  backgroundColorStyle: ColorStyle,
+  borders: CellBorders,
+  padding: CellPadding,
+  horizontalAlignment: HorizontalAlign,
+  verticalAlignment: VerticalAlign,
+  wrapStrategy: WrapStrategy,
+  textDirection: TextDirection,
+  textFormat: TextFormat
+  hyperlinkDisplayType: HyperlinkDisplayType,
+  textRotation: TextRotation,
+};
+
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#numberformat */
+export type NumberFormat = {
+  type: NumberFormatType;
+  /**
+   * pattern string used for formatting
+   * @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#numberformat
+   * */
+  pattern: string;
+};
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#GridProperties */
+export type WorksheetGridProperties = {
+  rowCount: number;
+  columnCount: number;
+  frozenRowCount?: number;
+  frozenColumnCount?: number;
+  hideGridlines?: boolean;
+  rowGroupControlAfter?: boolean;
+  columnGroupControlAfter?: boolean;
+};
+
+//
+
+/**
+ *
+ * @see https://developers.google.com/sheets/api/reference/rest/v4/DimensionRange
+ */
+export type DimensionRange = {
+  sheetId: WorksheetId,
+  dimension: WorksheetDimension,
+  startIndex?: Integer,
+  endIndex?: Integer,
+};
+export type DimensionRangeWithoutWorksheetId = Omit<DimensionRange, 'sheetId'>;
+
+/**
+ * object describing a range in a sheet
+ * see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#GridRange
+ * */
+export type GridRange = {
+  /** The sheet this range is on */
+  sheetId: WorksheetId,
+  /** The start row (inclusive) of the range, or not set if unbounded. */
+  startRowIndex?: Integer,
+  /** The end row (exclusive) of the range, or not set if unbounded. */
+  endRowIndex?: Integer,
+  /** The start column (inclusive) of the range, or not set if unbounded. */
+  startColumnIndex?: Integer,
+  /** The end column (exclusive) of the range, or not set if unbounded. */
+  endColumnIndex?: Integer
+};
+export type GridRangeWithoutWorksheetId = Omit<GridRange, 'sheetId'>;
+export type GridRangeWithOptionalWorksheetId = MakeOptional<GridRange, 'sheetId'>;
+export type DataFilter = A1Range | GridRange;
+export type DataFilterWithoutWorksheetId = A1Range | GridRangeWithoutWorksheetId;
+
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#colorstyle */
+export type ColorStyle = { Color: Color } | { themeColor: ThemeColorType };
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#Color */
+export type Color = {
+  red: number,
+  green: number,
+  blue: number,
+  /** docs say alpha is not generally supported? */
+  alpha?: number
+};
+
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/ValueRenderOption */
+type ValueRenderOption =
+/** Values will be calculated & formatted in the reply according to the cell's formatting. Formatting is based on the spreadsheet's locale, not the requesting user's locale. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "$1.23". */
+'FORMATTED_VALUE' |
+/** Values will be calculated, but not formatted in the reply. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return the number 1.23. */
+'UNFORMATTED_VALUE' |
+/** Values will not be calculated. The reply will include the formulas. For example, if A1 is 1.23 and A2 is =A1 and formatted as currency, then A2 would return "=A1". */
+'FORMULA';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/DateTimeRenderOption */
+type DateTimeRenderOption =
+/** Instructs date, time, datetime, and duration fields to be output as doubles in "serial number" format, as popularized by Lotus 1-2-3. The whole number portion of the value (left of the decimal) counts the days since December 30th 1899. The fractional portion (right of the decimal) counts the time as a fraction of the day. For example, January 1st 1900 at noon would be 2.5, 2 because it's 2 days after December 30th 1899, and .5 because noon is half a day. February 1st 1900 at 3pm would be 33.625. This correctly treats the year 1900 as not a leap year. */
+'SERIAL_NUMBER' |
+/** Instructs date, time, datetime, and duration fields to be output as strings in their given number format (which depends on the spreadsheet locale). */
+'FORMATTED_STRING';
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get#query-parameters */
+export type GetValuesRequestOptions = {
+  majorDimension?: WorksheetDimension,
+  valueRenderOption?: ValueRenderOption
+};
+
+
+
+
+/**
+ * Info about an error in a cell
+ * @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#errortype
+ */
+export type ErrorValue = {
+  type: CellValueErrorType,
+  message: string
+};
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#ExtendedValue */
+export type ExtendedValue =
+  { numberValue: number } |
+  { stringValue: string } |
+  { boolValue: boolean } |
+  { formulaValue: string } |
+  { errorValue: ErrorValue };
+export type CellValueType = 'boolValue' | 'stringValue' | 'numberValue' | 'errorValue';
+
+//------------------------------------
+
+/** @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells */
+export type CellData = {
+  /** The value the user entered in the cell. e.g., 1234, 'Hello', or =NOW() Note: Dates, Times and DateTimes are represented as doubles in serial number format. */
+  userEnteredValue: ExtendedValue,
+  /** The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the userEnteredValue. This field is read-only. */
+  effectiveValue: ExtendedValue,
+  /** The formatted value of the cell. This is the value as it's shown to the user. This field is read-only. */
+  formattedValue: string,
+
+  /** The format the user entered for the cell. */
+  userEnteredFormat: CellFormat,
+  /** The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written. This field is read-only. */
+  effectiveFormat: CellFormat,
+  /** hyperlink in the cell if any */
+  hyperlink?: string,
+  /** note on the cell */
+  note?: string,
+  // textFormatRuns: [
+  //   {
+  //     object (TextFormatRun)
+  //   }
+  // ],
+  // dataValidation: {
+  //   object (DataValidationRule)
+  // },
+  // pivotTable: {
+  //   object (PivotTable)
+  // },
+  // dataSourceTable: {
+  //   object (DataSourceTable)
+  // },
+  // dataSourceFormula: {
+  //   object (DataSourceFormula)
+  // }
+};
+
+/** shape of the cell data sent back when fetching the sheet */
+export type CellDataRange = {
+  startRow?: RowIndex,
+  startColumn?: ColumnIndex,
+  // TODO: fix these types
+  rowMetadata: any[],
+  columnMetadata: any[],
+  rowData: {
+    values: any[]
+  }[]
+};
+
+export type AddRowOptions = {
+
+  /** set to true to use raw mode rather than user entered */
+  raw?: boolean,
+  /** set to true to insert new rows in the sheet while adding this data */
+  insert?: boolean,
+};

package/src/lib/types/util-types.ts

@@ -0,0 +1,8 @@
+// utility types
+export type MakeOptional<Type, Key extends keyof Type> = Omit<Type, Key> &
+Partial<Pick<Type, Key>>;
+
+export type RecursivePartial<T> = {
+  [P in keyof T]?: RecursivePartial<T[P]>;
+};
+

package/src/lib/utils.ts

@@ -0,0 +1,57 @@
+import * as _ from './lodash';
+
+export function getFieldMask(obj: Record<string, unknown>) {
+  return Object.keys(obj).join(',');
+}
+
+export function columnToLetter(column: number) {
+  let temp;
+  let letter = '';
+  let col = column;
+  while (col > 0) {
+    temp = (col - 1) % 26;
+    letter = String.fromCharCode(temp + 65) + letter;
+    col = (col - temp - 1) / 26;
+  }
+  return letter;
+}
+
+export function letterToColumn(letter: string) {
+  let column = 0;
+  const { length } = letter;
+  for (let i = 0; i < length; i++) {
+    column += (letter.charCodeAt(i) - 64) * 26 ** (length - i - 1);
+  }
+  return column;
+}
+
+// send arrays in params with duplicate keys - ie `?thing=1&thing=2` vs `?thing[]=1...`
+// solution taken from https://github.com/axios/axios/issues/604
+export function axiosParamsSerializer(params: Record<PropertyKey, any>) {
+  let options = '';
+  Object.keys(params).forEach((key) => {
+    const isParamTypeObject = typeof params[key] === 'object';
+    const isParamTypeArray = isParamTypeObject && (params[key].length >= 0);
+    if (!isParamTypeObject) options += `${key}=${encodeURIComponent(params[key])}&`;
+    if (isParamTypeObject && isParamTypeArray) {
+      // eslint-disable-next-line no-restricted-syntax
+      for (const val of params[key]) {
+        options += `${key}=${encodeURIComponent(val)}&`;
+      }
+    }
+  });
+  return options ? options.slice(0, -1) : options;
+}
+
+
+export function checkForDuplicateHeaders(headers: string[]) {
+  // check for duplicate headers
+  const checkForDupes = _.groupBy(headers); // { c1: ['c1'], c2: ['c2', 'c2' ]}
+  _.each(checkForDupes, (grouped, header) => {
+    if (!header) return; // empty columns are skipped, so multiple is ok
+    if (grouped.length > 1) {
+      throw new Error(`Duplicate header detected: "${header}". Please make sure all non-empty headers are unique`);
+    }
+  });
+}
+